Snider/Borg
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Borg/docs/usage.md
google-labs-jules[bot] c68626985e feat: Add go.work, update module path, and add examples 
This commit introduces several maintenance improvements to the repository.

- A `go.work` file has been added to define the workspace and make the project easier to work with.
- The module path in `go.mod` has been updated to use a GitHub URL, and all import paths have been updated accordingly.
- `examples` and `docs` directories have been created.
- The `examples` directory contains scripts that demonstrate the tool's functionality.
- The `docs` directory contains documentation for the project.
- Tests have been added to the `pkg/github` package following the `_Good`, `_Bad`, `_Ugly` convention.
- The missing `pkg/borg` package has been added to resolve a build error.
2025-10-31 22:15:05 +00:00

563 B
Raw Blame History

Usage

This document explains how to use the Borg Data Collector.

collect git

The collect git command is used to clone a git repository and store it in a DataNode.

Example

borg collect git --uri https://github.com/torvalds/linux.git

collect website

The collect website command is used to crawl a website and store it in a DataNode.

Example

borg collect website --uri https://tldp.org/

serve

The serve command is used to serve a DataNode file.

Example

borg serve --file linux.borg