@caffeineai/cli 0.1.0-dev.23 → 0.1.0-dev.25

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +75 -15
  2. package/package.json +10 -10
package/README.md CHANGED
@@ -1,23 +1,31 @@
1
1
  # @caffeineai/cli
2
2
 
3
- Command-line interface for the Caffeine platform.
3
+ The public Caffeine command-line interface for authentication, project
4
+ management, local development workflows, and headless AI chat.
4
5
 
5
6
  ## Development Release
6
7
 
7
- This is a DEV release. It is published under the npm `dev` dist-tag and is subject to a rapid release cadence. Expect frequent updates while the CLI and MCP packages settle.
8
+ This is a DEV release. It is published under the npm `dev` dist-tag and is
9
+ subject to a rapid release cadence. Expect frequent updates while the CLI
10
+ package settles.
11
+
12
+ ## Features
13
+
14
+ - Device and browser-based login
15
+ - Project listing, inspection, creation, cloning, and deletion
16
+ - Local install, build, check, preview, import, export, config, doctor, and update flows
17
+ - Interactive and detached chat sessions over the Caffeine AI API
18
+ - Browser chat hand-off when you want the web UI
8
19
 
9
20
  ## Installation
10
21
 
11
22
  ```bash
12
23
  npm install -g @caffeineai/cli@dev
24
+ caffeine --version
13
25
  ```
14
26
 
15
27
  Three equivalent command names are installed: `caffeine`, `caf`, and `cfn`.
16
28
 
17
- ```bash
18
- caffeine --version
19
- ```
20
-
21
29
  ## Quick Start
22
30
 
23
31
  ```bash
@@ -48,19 +56,63 @@ Native binaries ship for:
48
56
  | Projects | `projects create <name>` | Create a new project |
49
57
  | Projects | `projects clone <id> [--dest <path>] [--include-wip]` | Clone a project locally |
50
58
  | Projects | `projects delete <id>` | Delete a project |
51
- | Local | `import` | Import a project from a .zip |
52
- | Local | `export` | Export the current project to a .zip |
59
+ | Local | `import <file>` | Import a project from a `.zip` |
60
+ | Local | `export` | Export the current project to a `.zip` |
53
61
  | Build | `install` | Install build dependencies |
54
62
  | Build | `build` | Build the current project |
55
63
  | Build | `check` | Validate code and configuration |
56
64
  | Build | `preview` | Upload a built project as a draft |
57
- | Config | `config list` / `get <key>` / `set <key> <value>` | Manage CLI config |
65
+ | Chat | `chat send <message>` | Start an interactive chat session |
66
+ | Chat | `chat send --detach <message>` | Submit and return immediately |
67
+ | Chat | `chat reply <message>` | Send a freeform clarification reply |
68
+ | Chat | `chat active` | Discover likely active chat sessions |
69
+ | Chat | `chat status` | Show a high-level summary for an active session |
70
+ | Chat | `chat watch` | Attach to a live session and stream updates |
71
+ | Chat | `chat resume` | Reattach and wait for the next stable state |
72
+ | Chat | `chat transcript` | Show the current transcript |
73
+ | Chat | `chat feed` | Collect raw project feed events |
74
+ | Chat | `chat list` | List chat messages |
75
+ | Chat | `chat tail` | Poll chat messages until the AI reaches a stable state |
76
+ | Chat | `chat submit-form` | Submit a structured clarification form reply |
77
+ | Chat | `chat open` | Open the browser chat for a project |
78
+ | Config | `config list` / `config get <key>` / `config set <key> <value>` | Manage CLI config |
58
79
  | Env | `doctor [--fix]` | Diagnose local build prerequisites |
59
80
  | Meta | `update` | Check for or install a newer CLI |
60
81
  | Meta | `version` | Show version info |
61
82
 
62
83
  Run `caffeine <command> --help` for the full flag list.
63
84
 
85
+ ## Chat Workflow
86
+
87
+ ```bash
88
+ caffeine chat send "Build a weather dashboard"
89
+ caffeine chat send --detach "Build a weather dashboard"
90
+ caffeine chat active
91
+ caffeine chat status
92
+ caffeine chat watch --project-id 11111111-1111-4111-8111-111111111111
93
+ caffeine chat resume --project-id 11111111-1111-4111-8111-111111111111
94
+ caffeine chat transcript --project-id 11111111-1111-4111-8111-111111111111
95
+ caffeine chat feed --project-id 11111111-1111-4111-8111-111111111111 --timeout 5s
96
+ caffeine chat submit-form \
97
+ --project-id 11111111-1111-4111-8111-111111111111 \
98
+ --message-index 42 \
99
+ --form-data '{"appName":"Habit Hero"}'
100
+ caffeine chat open
101
+ ```
102
+
103
+ All commands support `--json` for machine-readable output.
104
+
105
+ `chat send` is interactive by default: it stays attached, streams progress and
106
+ transcript updates, and exits when the session completes or needs
107
+ clarification. Use `--detach` if you explicitly want a fire-and-check-later
108
+ workflow.
109
+
110
+ Clarification handling:
111
+
112
+ - `ai_follow_up` means the AI wants more freeform input, so reply with `chat reply`
113
+ - `system_dialog` with `info.form` means you should call `chat submit-form`
114
+ - `ai_answer` means the exchange completed successfully
115
+
64
116
  ## JSON And Non-Interactive Mode
65
117
 
66
118
  Every command accepts `--json`. JSON output uses a stable envelope:
@@ -74,22 +126,30 @@ Use `--non-interactive` in scripts and CI.
74
126
 
75
127
  ## Authentication
76
128
 
77
- `caffeine auth login` opens your browser for an OAuth flow. For CI or remote SSH, add `--device` to use the device flow instead.
129
+ `caffeine auth login` opens your browser for an OAuth flow. For CI, remote
130
+ SSH, or other headless environments, add `--device` to use the device flow
131
+ instead.
78
132
 
79
- Tokens are stored in your OS credential store. The `@caffeineai/mcp` server reads the same credentials, so one login covers both packages.
133
+ Tokens are stored in your OS credential store.
80
134
 
81
135
  ## MCP Server
82
136
 
83
- Drive Caffeine from Claude Code, Cursor, VS Code, Codex, Windsurf, or another MCP host with the companion MCP server:
137
+ Drive Caffeine from Claude Code, Cursor, VS Code, Codex, Windsurf, or another
138
+ MCP host with the companion MCP server:
84
139
 
85
140
  ```bash
86
141
  npx -y @caffeineai/mcp@dev --version
87
142
  ```
88
143
 
89
- See the `@caffeineai/mcp` README for host configuration.
144
+ The CLI and MCP server share the same auth, project, build, and chat contract.
145
+ One login flow can cover both tools on the same machine.
90
146
 
91
- ## Links
147
+ ## Notes
92
148
 
93
- - Caffeine platform: https://caffeine.ai
149
+ - `caffeine` with no subcommand opens the interactive terminal UI when run in
150
+ an interactive terminal.
151
+ - `caffeine chat open` hands the current project off to the browser chat UI.
152
+ - `caffeine doctor --fix` installs missing local build prerequisites when
153
+ possible.
94
154
 
95
155
  This package installs the matching platform binary through npm optional dependencies. Install the main package rather than a platform package directly.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@caffeineai/cli",
3
- "version": "0.1.0-dev.23",
3
+ "version": "0.1.0-dev.25",
4
4
  "description": "Caffeine CLI",
5
5
  "homepage": "https://caffeine.ai",
6
6
  "license": "SEE LICENSE IN LICENSE",
@@ -15,14 +15,14 @@
15
15
  "LICENSE"
16
16
  ],
17
17
  "optionalDependencies": {
18
- "@caffeineai/cli-darwin-arm64": "0.1.0-dev.23",
19
- "@caffeineai/cli-darwin-x64": "0.1.0-dev.23",
20
- "@caffeineai/cli-linux-arm64-glibc": "0.1.0-dev.23",
21
- "@caffeineai/cli-linux-x64-glibc": "0.1.0-dev.23",
22
- "@caffeineai/cli-linux-arm64-musl": "0.1.0-dev.23",
23
- "@caffeineai/cli-linux-x64-musl": "0.1.0-dev.23",
24
- "@caffeineai/cli-win32-arm64": "0.1.0-dev.23",
25
- "@caffeineai/cli-win32-x64": "0.1.0-dev.23"
18
+ "@caffeineai/cli-darwin-arm64": "0.1.0-dev.25",
19
+ "@caffeineai/cli-darwin-x64": "0.1.0-dev.25",
20
+ "@caffeineai/cli-linux-arm64-glibc": "0.1.0-dev.25",
21
+ "@caffeineai/cli-linux-x64-glibc": "0.1.0-dev.25",
22
+ "@caffeineai/cli-linux-arm64-musl": "0.1.0-dev.25",
23
+ "@caffeineai/cli-linux-x64-musl": "0.1.0-dev.25",
24
+ "@caffeineai/cli-win32-arm64": "0.1.0-dev.25",
25
+ "@caffeineai/cli-win32-x64": "0.1.0-dev.25"
26
26
  },
27
27
  "preferGlobal": true,
28
28
  "publishConfig": {
@@ -31,6 +31,6 @@
31
31
  "caffeine": {
32
32
  "distribution": "npmjs",
33
33
  "packageName": "@caffeineai/cli",
34
- "publishedAt": "2026-05-11T22:56:21.469Z"
34
+ "publishedAt": "2026-05-12T19:39:42.804Z"
35
35
  }
36
36
  }