@caffeineai/cli 0.1.0-dev.4 → 0.1.0-dev.40

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 +85 -15
  2. package/package.json +16 -13
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,78 @@ 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` | Open or continue the primary interactive chat workflow |
66
+ | Chat | `chat interactive` | Explicit form of the interactive chat workflow |
67
+ | Chat | `chat send <message>` | Send a prompt and stay attached until stable |
68
+ | Chat | `chat send --detach <message>` | Submit and return immediately |
69
+ | Chat | `chat reply <message>` | Send a freeform clarification reply |
70
+ | Chat | `chat active` | Discover likely active chat sessions |
71
+ | Chat | `chat status` | Show a high-level summary for an active session |
72
+ | Chat | `chat watch` | Attach to a live session and stream updates |
73
+ | Chat | `chat resume` | Reattach and wait for the next stable state |
74
+ | Chat | `chat transcript` | Show the current transcript |
75
+ | Chat | `chat feed` | Collect raw project feed events |
76
+ | Chat | `chat list` | List chat messages |
77
+ | Chat | `chat tail` | Poll chat messages until the AI reaches a stable state |
78
+ | Chat | `chat submit-form` | Submit a structured clarification form reply |
79
+ | Chat | `chat open` | Open the browser chat for a project |
80
+ | Config | `config list` / `config get <key>` / `config set <key> <value>` | Manage CLI config |
58
81
  | Env | `doctor [--fix]` | Diagnose local build prerequisites |
59
82
  | Meta | `update` | Check for or install a newer CLI |
60
83
  | Meta | `version` | Show version info |
61
84
 
62
85
  Run `caffeine <command> --help` for the full flag list.
63
86
 
87
+ ## Chat Workflow
88
+
89
+ ```bash
90
+ caffeine chat
91
+ caffeine chat --project-id 11111111-1111-4111-8111-111111111111
92
+ caffeine chat interactive --project-id 11111111-1111-4111-8111-111111111111
93
+ caffeine chat send --detach "Build a weather dashboard"
94
+ caffeine chat active
95
+ caffeine chat status
96
+ caffeine chat watch --project-id 11111111-1111-4111-8111-111111111111
97
+ caffeine chat resume --project-id 11111111-1111-4111-8111-111111111111
98
+ caffeine chat transcript --project-id 11111111-1111-4111-8111-111111111111
99
+ caffeine chat feed --project-id 11111111-1111-4111-8111-111111111111 --timeout 5s
100
+ caffeine chat submit-form \
101
+ --project-id 11111111-1111-4111-8111-111111111111 \
102
+ --message-index 42 \
103
+ --form-data '{"appName":"Habit Hero"}'
104
+ caffeine chat open
105
+ ```
106
+
107
+ All commands support `--json` for machine-readable output.
108
+
109
+ `caffeine chat` is the primary human workflow. It resumes likely active chat
110
+ sessions for the target project, shows a recent transcript tail when nothing is
111
+ active, and lets you continue the conversation inline until you exit.
112
+
113
+ `chat interactive` is the explicit equivalent of bare `chat`.
114
+
115
+ Use the lower-level subcommands when you want a more scripted or detached flow:
116
+
117
+ - `chat send --detach` submits work and returns immediately
118
+ - `chat watch` and `chat resume` reattach to in-flight work
119
+ - `chat transcript`, `chat list`, `chat tail`, and `chat feed` expose the raw chat state
120
+ - `chat reply` and `chat submit-form` let you answer clarifications explicitly
121
+
122
+ Interactive chat does not support `--json`. Use the lower-level subcommands for
123
+ automation, CI, and machine-readable output.
124
+
125
+ Clarification handling:
126
+
127
+ - `ai_follow_up` means the AI wants more freeform input, so reply with `chat reply`
128
+ - `system_dialog` with `info.form` means you should call `chat submit-form`
129
+ - `ai_answer` means the exchange completed successfully
130
+
64
131
  ## JSON And Non-Interactive Mode
65
132
 
66
133
  Every command accepts `--json`. JSON output uses a stable envelope:
@@ -74,23 +141,26 @@ Use `--non-interactive` in scripts and CI.
74
141
 
75
142
  ## Authentication
76
143
 
77
- `caffeine auth login` opens your browser for an OAuth flow. For CI or remote SSH, add `--device` to use the device flow instead.
144
+ `caffeine auth login` opens your browser for an OAuth flow. For CI, remote
145
+ SSH, or other headless environments, add `--device` to use the device flow
146
+ instead.
78
147
 
79
- Tokens are stored in your OS credential store. The `@caffeineai/mcp` server reads the same credentials, so one login covers both packages.
148
+ Tokens are stored in your OS credential store.
80
149
 
81
150
  ## MCP Server
82
151
 
83
- Drive Caffeine from Claude Code, Cursor, VS Code, Codex, Windsurf, or another MCP host with the companion MCP server:
152
+ Drive Caffeine from Claude Code, Cursor, VS Code, Codex, Windsurf, or another
153
+ MCP host with the companion MCP server:
84
154
 
85
155
  ```bash
86
156
  npx -y @caffeineai/mcp@dev --version
87
157
  ```
88
158
 
89
- See the `@caffeineai/mcp` README for host configuration.
159
+ The CLI and MCP server share the same auth, project, build, and chat contract.
160
+ One login flow can cover both tools on the same machine.
90
161
 
91
162
  ## Links
92
163
 
93
- - Source, issues, and release notes: https://github.com/caffeinelabs/caffeine-cli
94
- - Caffeine platform: https://caffeine.ai
164
+ Caffeine platform: https://caffeine.ai
95
165
 
96
166
  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,11 +1,8 @@
1
1
  {
2
2
  "name": "@caffeineai/cli",
3
- "version": "0.1.0-dev.4",
3
+ "version": "0.1.0-dev.40",
4
4
  "description": "Caffeine CLI",
5
- "repository": {
6
- "type": "git",
7
- "url": "git+https://github.com/caffeinelabs/caffeine-cli.git"
8
- },
5
+ "homepage": "https://caffeine.ai",
9
6
  "license": "SEE LICENSE IN LICENSE",
10
7
  "bin": {
11
8
  "caffeine": "bin/caffeine.js",
@@ -18,16 +15,22 @@
18
15
  "LICENSE"
19
16
  ],
20
17
  "optionalDependencies": {
21
- "@caffeineai/cli-darwin-arm64": "0.1.0-dev.4",
22
- "@caffeineai/cli-darwin-x64": "0.1.0-dev.4",
23
- "@caffeineai/cli-linux-arm64-glibc": "0.1.0-dev.4",
24
- "@caffeineai/cli-linux-x64-glibc": "0.1.0-dev.4",
25
- "@caffeineai/cli-linux-arm64-musl": "0.1.0-dev.4",
26
- "@caffeineai/cli-linux-x64-musl": "0.1.0-dev.4",
27
- "@caffeineai/cli-win32-arm64": "0.1.0-dev.4",
28
- "@caffeineai/cli-win32-x64": "0.1.0-dev.4"
18
+ "@caffeineai/cli-darwin-arm64": "0.1.0-dev.40",
19
+ "@caffeineai/cli-darwin-x64": "0.1.0-dev.40",
20
+ "@caffeineai/cli-linux-arm64-glibc": "0.1.0-dev.40",
21
+ "@caffeineai/cli-linux-x64-glibc": "0.1.0-dev.40",
22
+ "@caffeineai/cli-linux-arm64-musl": "0.1.0-dev.40",
23
+ "@caffeineai/cli-linux-x64-musl": "0.1.0-dev.40",
24
+ "@caffeineai/cli-win32-arm64": "0.1.0-dev.40",
25
+ "@caffeineai/cli-win32-x64": "0.1.0-dev.40"
29
26
  },
27
+ "preferGlobal": true,
30
28
  "publishConfig": {
31
29
  "access": "public"
30
+ },
31
+ "caffeine": {
32
+ "distribution": "npmjs",
33
+ "packageName": "@caffeineai/cli",
34
+ "publishedAt": "2026-06-17T12:55:55.945Z"
32
35
  }
33
36
  }