@kombai/cli 0.0.0-stage → 0.1.0

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.
package/LICENSE ADDED
@@ -0,0 +1,24 @@
1
+ Copyright (c) 2025-2026 Kombai INC. All rights reserved.
2
+
3
+ This software is the proprietary property of Kombai and is licensed, not sold. By installing or using the Kombai CLI, you agree to the following terms:
4
+
5
+ 1. **License Grant**: Kombai grants you a limited, non-exclusive, non-transferable, and revocable license to use this software solely for personal or internal business purposes.
6
+
7
+ 2. **Restrictions**:
8
+
9
+ - You may not copy, modify, distribute, sell, sublicense, reverse engineer, decompile, or disassemble any part of this software.
10
+ - You may not use the software to develop or distribute competing products.
11
+
12
+ 3. **Ownership**: All intellectual property rights in and to this software are and shall remain the sole property of Kombai.
13
+
14
+ 4. **Disclaimer of Warranties**:
15
+ This software is provided "as is", without warranty of any kind, express or implied, including but not limited to warranties of merchantability, fitness for a particular purpose, or non-infringement.
16
+
17
+ 5. **Limitation of Liability**:
18
+ In no event shall Kombai be liable for any direct, indirect, incidental, special, or consequential damages arising out of the use or inability to use this software.
19
+
20
+ 6. **Termination**: This license terminates automatically if you violate any of the terms. Upon termination, you must stop using and destroy all copies of the software.
21
+
22
+ 7. **Third-Party Software**: This software includes open-source components, listed with their licenses in dist/THIRD-PARTY-NOTICES.txt. Each is governed by its own license, not by these terms.
23
+
24
+ For any questions regarding licensing, please contact: support@kombai.com
package/README.md CHANGED
@@ -1,3 +1,80 @@
1
- # Temporary Holding Version
1
+ # Kombai CLI
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Design UI with Kombai from your coding agent. Claude Code, Codex, Cursor or any agent with a terminal
4
+ runs `kombai` to get design directions grounded in your repo, write each design as HTML on a hosted Kombai
5
+ canvas, and check its thumbnail. You review the designs on the canvas in your browser.
6
+
7
+ ## Requirements
8
+
9
+ - Node.js 20 or later
10
+ - A Kombai account
11
+ - For thumbnails, a Chromium browser: Chrome, Edge, Brave, Arc or Chromium. Without one,
12
+ `kombai browser install` downloads a headless Chromium (about 100 MB) after asking. That download
13
+ is x86-64 only on Linux: on ARM, install your distribution's `chromium` and point the CLI at it
14
+ with `kombai config browser <path>`.
15
+
16
+ ## Getting started
17
+
18
+ There is nothing to install. Agents run every command through npx:
19
+
20
+ ```sh
21
+ npx -y @kombai/cli@latest skill # the agent's instructions
22
+ npx -y @kombai/cli@latest login # sign in through your browser
23
+ ```
24
+
25
+ `login` prints a match code and opens a Kombai page in your browser. Approve the sign-in there only
26
+ if the code matches the one in your terminal.
27
+
28
+ `kombai guest` tries Kombai without an account, on one canvas, and `kombai login` later keeps that canvas.
29
+
30
+ ## Commands
31
+
32
+ | Area | Commands |
33
+ | ----------------- | -------------------------------------------------------------------------------------------------------------------------- |
34
+ | Instructions | `skill` |
35
+ | Sign-in | `login`, `logout`, `whoami`, `guest`, `claim` |
36
+ | Account | `credits` |
37
+ | Design directions | `taste start`, `taste wait` |
38
+ | Canvases | `canvas create`, `canvas list`, `canvas pull`, `canvas push`, `canvas url`, `canvas open`, `canvas share`, `canvas delete` |
39
+ | Designs | `node start`, `node lock`, `node unlock`, `node pull`, `node push`, `asset push` |
40
+ | Design systems | `ds list`, `ds pull`, `ds push`, `ds delete` |
41
+ | Thumbnails | `screenshot fill`, `screenshot wait`, `browser install`, `config browser` |
42
+ | Settings | `config org` |
43
+ | Codex view | `mcp` (Codex starts it; it serves the canvas view beside the chat) |
44
+
45
+ `kombai --help` lists them with what each does, `kombai <command> --help` gives one command's flags,
46
+ `kombai canvas --help` (or `ds`, `node` or any other command's first word) gives the flags of every
47
+ command that starts with that word, and `kombai --version` prints the version to quote in a bug report.
48
+
49
+ ## Output
50
+
51
+ Each command prints one JSON line on stdout (`--pretty` indents it) and exits with:
52
+
53
+ | Code | Meaning |
54
+ | ---- | -------------------------------------------------------------------------------------------------- |
55
+ | 0 | Done |
56
+ | 1 | Failed; the line's `error` says why |
57
+ | 2 | Refused: someone else changed it, or a local edit was not pushed; pull or merge, then run it again |
58
+ | 3 | Not signed in; run `kombai login` |
59
+ | 4 | Timed out; run the line's `next` to carry on |
60
+
61
+ An error line carries a `code`, a `message`, and often a `next`: the command to run next.
62
+
63
+ ## What it keeps on your machine
64
+
65
+ Your sign-in key is saved under `~/.kombai/cli`, in a file only your user can read. `kombai logout`
66
+ deletes it here and on Kombai's servers.
67
+
68
+ The CLI sends Kombai a usage event for each command (which command ran, how it ended and how long it
69
+ took) and reports unexpected errors, so problems can be fixed. Set `DO_NOT_TRACK=1` to turn both off.
70
+
71
+ ## Support
72
+
73
+ Email support@kombai.com with what you ran, the JSON line it printed, and the version
74
+ `kombai --version` prints.
75
+
76
+ ## License
77
+
78
+ Copyright (c) 2025-2026 Kombai INC. All rights reserved. The Kombai CLI is proprietary software; the
79
+ terms are in the LICENSE file in this package. It bundles open-source packages, which keep their own
80
+ licenses: `dist/THIRD-PARTY-NOTICES.txt` lists each one with its license text.