Skip to content

Commit

Permalink
docs: Added design guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
tazarov committed Mar 18, 2024
1 parent f81eb99 commit 55f51fe
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 9 deletions.
11 changes: 11 additions & 0 deletions docs/docs/cli-design-guidelines.md
Original file line number Diff line number Diff line change
@@ -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
19 changes: 10 additions & 9 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,22 +9,23 @@

### Add Server

```bash
chroma server add <server-alias> -H <host> -p <port>
```

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 <server-alias> -h <host> -p <port> -o -s -t <tenant> -d <database>
```
- `--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

Expand Down

0 comments on commit 55f51fe

Please sign in to comment.