Skip to content

Commit

Permalink
Update README.mdx (#87)
Browse files Browse the repository at this point in the history
  • Loading branch information
usarid committed May 24, 2023
1 parent f59bc6a commit 3350cfb
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/reference/cli/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ The following are the commands offered by the Otterize CLI.

## Command structure

Most CLI commands are of the form `otterize OBJECT ACTION`. Because there are multiple objects
which each have multiple operations, this order makes the auto-completion and documentation built into the CLI
easy to access on the fly.
Most CLI commands are of the form `otterize NOUN VERB` where the `NOUN` is the type of object (e.g. `intents`, `clusters`) and the `VERB` is the operation being performed.
Putting the `NOUN` first makes the auto-completion and documentation built into the CLI easier to consume: you first choose the type of object you are interested in,
then the built-in auto-completion or documentation shows you the options on that type of object.

- `otterize -h` or `otterize --help` offers help on the various objects
- `otterize OBJECT -h` or `otterize OBJECT --help` offers help on the specified object
- `otterize OBJECT OPERATION -h` or `otterize OBJECT OPERATION --help` offers help on the specified operation
- `otterize -h` or `otterize --help` lists the various object types.
- `otterize NOUN -h` or `otterize NOUN --help` offers help on the specified object type.
- `otterize NOUN VERB -h` or `otterize NOUN VERB --help` offers help on the specified operation.

`otterize completion` offers instruction for generating command completions in various shells.

Expand Down

0 comments on commit 3350cfb

Please sign in to comment.