Skip to content

Commit 87e9337

Browse files
update README with setup command
1 parent a8af927 commit 87e9337

File tree

1 file changed

+30
-12
lines changed

1 file changed

+30
-12
lines changed

README.md

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,27 @@ Download a prebuilt binary from the [Releases](https://github.com/mintplex-labs/
6262

6363
2. **Set your environment variables:**
6464

65+
#### macOS / Linux
66+
67+
Run the interactive setup command to configure your environment automatically:
68+
6569
```bash
66-
export ANYTHING_LLM_API_KEY="your-api-key"
67-
# Optional — defaults to http://localhost:3001
68-
export ANYTHING_LLM_BASE_URL="https://my-instance.example.com"
70+
any setup
6971
```
7072

71-
> **Tip:** Add these to your `.bashrc` or `.zshrc` for persistence.
73+
This will prompt you for your instance type, base URL, and API key, then write the appropriate exports to your shell config file (`.zshrc`, `.bashrc`, or `config.fish`).
74+
75+
#### Windows
76+
77+
Windows users need to set environment variables manually:
78+
79+
```powershell
80+
# PowerShell (current session)
81+
$env:ANYTHING_LLM_BASE_URL = "https://my-instance.example.com"
82+
$env:ANYTHING_LLM_API_KEY = "your-api-key"
83+
84+
# To persist across sessions, use System Environment Variables settings
85+
```
7286

7387
3. **Send your first prompt:**
7488

@@ -80,9 +94,13 @@ That's it! If no workspace is specified, the CLI will automatically create and u
8094

8195
## Usage
8296

83-
```
84-
any prompt <message> [options]
85-
```
97+
### `any setup` (alias: `s`)
98+
99+
Interactive setup wizard that configures your AnythingLLM connection. Prompts for your instance type (Desktop or Cloud/Self-Hosted), base URL, and API key, then writes the environment variables to your shell config file.
100+
101+
> **Note:** Only available on macOS and Linux. Windows users must set environment variables manually.
102+
103+
### `any prompt <message>` (alias: `p`)
86104

87105
### Options
88106

@@ -125,11 +143,11 @@ any prompt "Write a summary" > summary.md
125143
126144
## Environment Variables
127145

128-
| Variable | Required | Default | Description |
129-
| ------------------------------------- | -------- | ----------------------- | ------------------------------------------------- |
130-
| `ANYTHING_LLM_API_KEY` | Yes | | Your AnythingLLM API key |
131-
| `ANYTHING_LLM_BASE_URL` | No | `http://localhost:3001` | Base URL of your AnythingLLM instance |
132-
| `ANYTHING_LLM_DEFAULT_WORKSPACE_SLUG` | No | | Default workspace slug (avoids needing `-w` flag) |
146+
| Variable | Required | Default | Description |
147+
| ------------------------------------- | -------- | ------- | ------------------------------------------------- |
148+
| `ANYTHING_LLM_API_KEY` | Yes || Your AnythingLLM API key |
149+
| `ANYTHING_LLM_BASE_URL` | Yes | | Base URL of your AnythingLLM instance |
150+
| `ANYTHING_LLM_DEFAULT_WORKSPACE_SLUG` | No || Default workspace slug (avoids needing `-w` flag) |
133151

134152
## Development
135153

0 commit comments

Comments
 (0)