diff --git a/docs/docs/cli-design-guidelines.md b/docs/docs/cli-design-guidelines.md new file mode 100644 index 0000000..8190e80 --- /dev/null +++ b/docs/docs/cli-design-guidelines.md @@ -0,0 +1,11 @@ +# Our North Star + +- Keep it simple +- Don't make it confusing +- Shorthands are to be used mostly when they create continuity between Unix tools and Chroma commands (e.g. `-f` forces + an operation without user confirmation) +- Command naming should follow Unix command line tooling wherever possible - again logical continuity and user mental + models are important +- Avoid long-name command or flag names + +## Some \ No newline at end of file diff --git a/docs/docs/index.md b/docs/docs/index.md index 13239c3..cecce42 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -9,22 +9,23 @@ ### Add Server +```bash +chroma server add -H -p +``` + Arguments: - `server-alias` - Alias for the server Flags: -- `-h` or `--host` - Hostname of the server +- `-H` or `--host` - Hostname of the server - `-p` or `--port` - Port of the server -- `-o` or `--overwrite` - Overwrite existing server alias -- `-s` or `--secure` - Use secure connection (TLS) -- `-t` or `--tenant` - Tenant Name to use by default -- `-d` or `--database` - Database Name to use by default - -```bash -chroma server add -h -p -o -s -t -d -``` +- `--overwrite` - Overwrite existing server alias +- `--secure` - Use secure connection (TLS) +- `--tenant` - Tenant Name to use by default +- `--database` - Database Name to use by default +- `--login` - Prompts the user for auth type and credentials ### Switch Server