Skip to content

Commit 39bd2db

Browse files
murphm8jchionh
authored andcommitted
Update README.md (#12)
1 parent 30b5208 commit 39bd2db

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,28 @@
11
## AWS Robomaker Bundle Support Library
22

3+
**This API is currently under active development and should not be considered stable.**
4+
35
A Library in Go that supports download and extraction of colcon-bundle format. https://github.com/colcon/colcon-bundle
46

7+
## CLI
8+
9+
We provide a rudimentary CLI to expose the base functionality of this library.
10+
With `GOMODULE11=on` you can run it by executing:
11+
12+
`go run github.com/aws-robotics/aws-robomaker-bundle-support-library/cmd/cli`
13+
14+
Usage:
15+
16+
```
17+
./cli --bundle my_bundle.tar
18+
19+
--bundle - Path to bundle file
20+
--prefix - Prefix to put onto the source command. This is generally used when the CLI is run
21+
on a host, but the source command will run inside a Docker container. If you have your cache
22+
directory mounted as '/cache' in the Docker container you should set prefix to '/cache'.
23+
24+
```
25+
526
## License
627

728
This library is licensed under the Apache 2.0 License.

0 commit comments

Comments
 (0)