Skip to content

Commit

Permalink
Merge pull request #16 from Priyanshuthapliyal2005/main
Browse files Browse the repository at this point in the history
fix(docs): Update README for Windows Bash auto-completion and correct…
  • Loading branch information
deeglaze authored Dec 23, 2024
2 parents 4eada92 + 6b4f5c7 commit 21c26de
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,18 @@ To install the `cocli` command, do:
```
$ go install github.com/veraison/cocli@latest
```

To configure auto-completion, use the `completion` subcommand. For example, if
`bash` is your shell, you would do something like:
To configure auto-completion, use the `completion` subcommand. For example, if `bash` is your shell, you would do something like:
```
$ cocli completion bash > ~/.bash_completion.d/cocli
$ . ~/.bash_completion
```

If you are using Git Bash or a similar environment, you would do something like:
```
$ mkdir -p ~/.local/share/bash-completion/completions
$ cocli completion bash > ~/.local/share/bash-completion/completions/cocli
$ source ~/.local/share/bash-completion/completions/cocli
```
to get automatic command completion and suggestions using the TAB key.

To get a list of the supported shells, do:
Expand Down Expand Up @@ -231,7 +236,7 @@ Use the `cots create` subcommand to create a CBOR-encoded CoTS. The `environment


```
$ cocli cots create --environment data/cots/env/vendor.json --tafile data/cots/shared_ta.ta
$ cocli cots create --environment data/cots/templates/env/vendor.json --tafile data/cots/shared_ta.ta
```
On success, you should see something like the following printed to stdout:
```
Expand All @@ -242,7 +247,7 @@ The CBOR-encoded CoTS file is stored in the current working directory with a
name derived from its environment template. If you want, you can specify a different
target directory and file name using the `--output` command line switch (abbrev. `-o`)
```
$ cocli cots create --environment data/cots/env/vendor.json --tafile data/cots/shared_ta.ta --output /tmp/myCots.cbor
$ cocli cots create --environment data/cots/templates/env/vendor.json --tafile data/cots/shared_ta.ta --output /tmp/myCots.cbor
>> created "/tmp/myCots.cbor"
```
Note that the output directory, as well as all its parent directories, MUST pre-exist.
Expand Down

0 comments on commit 21c26de

Please sign in to comment.