@kombai/cli 0.1.5-beta.1 → 0.1.5
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/README.md +4 -4
- package/dist/kombai.mjs +8 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,12 +15,12 @@ canvas, and check its thumbnail. You review the designs on the canvas in your br
|
|
|
15
15
|
|
|
16
16
|
## Getting started
|
|
17
17
|
|
|
18
|
-
There is nothing to install. Agents run every command through npx
|
|
19
|
-
|
|
18
|
+
There is nothing to install. Agents run every command through npx (the Kombai plugin pins the version
|
|
19
|
+
it runs):
|
|
20
20
|
|
|
21
21
|
```sh
|
|
22
|
-
npx -y @kombai/cli@
|
|
23
|
-
npx -y @kombai/cli@
|
|
22
|
+
npx -y @kombai/cli@latest skill # the agent's instructions
|
|
23
|
+
npx -y @kombai/cli@latest login # sign in through your browser
|
|
24
24
|
```
|
|
25
25
|
|
|
26
26
|
`login` prints a match code and opens a Kombai page in your browser. Approve the sign-in there only
|
package/dist/kombai.mjs
CHANGED
|
@@ -1557,9 +1557,9 @@ var init_env = __esm({
|
|
|
1557
1557
|
preprod: { api: "https://api.assistant.preprod.kombai.com", web: "https://agent.preprod.kombai.com" },
|
|
1558
1558
|
prod: { api: "https://api.assistant.app.kombai.com", web: "https://agent.kombai.com" }
|
|
1559
1559
|
});
|
|
1560
|
-
DEFAULT_ENV = Object.hasOwn(ENVIRONMENTS, "
|
|
1560
|
+
DEFAULT_ENV = Object.hasOwn(ENVIRONMENTS, "prod") ? (
|
|
1561
1561
|
/** @type {EnvName} */
|
|
1562
|
-
"
|
|
1562
|
+
"prod"
|
|
1563
1563
|
) : "prod";
|
|
1564
1564
|
}
|
|
1565
1565
|
});
|
|
@@ -1766,17 +1766,6 @@ var init_chatMcpRegistrationArg = __esm({
|
|
|
1766
1766
|
}
|
|
1767
1767
|
});
|
|
1768
1768
|
|
|
1769
|
-
// ../shared/src/mcp/kombaiCliVersion.ts
|
|
1770
|
-
var KOMBAI_CLI_VERSION, KOMBAI_CLI_PACKAGE;
|
|
1771
|
-
var init_kombaiCliVersion = __esm({
|
|
1772
|
-
"../shared/src/mcp/kombaiCliVersion.ts"() {
|
|
1773
|
-
"use strict";
|
|
1774
|
-
init_define_KOMBAI_TELEMETRY();
|
|
1775
|
-
KOMBAI_CLI_VERSION = "0.1.4";
|
|
1776
|
-
KOMBAI_CLI_PACKAGE = `@kombai/cli@${KOMBAI_CLI_VERSION}`;
|
|
1777
|
-
}
|
|
1778
|
-
});
|
|
1779
|
-
|
|
1780
1769
|
// ../shared/src/mcp/codexKombaiEntry.ts
|
|
1781
1770
|
function kombaiCliMcpEntry(platform2, cliPackage = KOMBAI_CLI_PACKAGE) {
|
|
1782
1771
|
const args = ["-y", cliPackage, "mcp"];
|
|
@@ -2064,15 +2053,15 @@ function withCodexKombaiCommand(content, platform2, cliPackage) {
|
|
|
2064
2053
|
}
|
|
2065
2054
|
return bom + parts.join("");
|
|
2066
2055
|
}
|
|
2067
|
-
var KOMBAI_MCP_KEY, KOMBAI_CLI_MCP_COMMAND, WINDOWS_SHELL_WRAPPER, KOMBAI_CLI_PACKAGE_RE, LEGACY_LAUNCHER_RE, KOMBAI_TOML_TABLE, TOML_OTHER_HEADER, KOMBAI_TOML_BLOCK_RE, KOMBAI_TOML_AT_START_RE, tomlCommandLine, tomlArgsLine, BOM, withoutBom, TOML_HEADER_LINE_RE, MULTILINE_QUOTES, MCP_SERVERS_HEADER_RE, KOMBAI_KEY_LINE_RE, MCP_SERVERS_KEY_LINE_RE, KOMBAI_TABLE_HEADER_RE, COMMAND_OR_ARGS_RE;
|
|
2056
|
+
var KOMBAI_MCP_KEY, KOMBAI_CLI_MCP_COMMAND, KOMBAI_CLI_PACKAGE, WINDOWS_SHELL_WRAPPER, KOMBAI_CLI_PACKAGE_RE, LEGACY_LAUNCHER_RE, KOMBAI_TOML_TABLE, TOML_OTHER_HEADER, KOMBAI_TOML_BLOCK_RE, KOMBAI_TOML_AT_START_RE, tomlCommandLine, tomlArgsLine, BOM, withoutBom, TOML_HEADER_LINE_RE, MULTILINE_QUOTES, MCP_SERVERS_HEADER_RE, KOMBAI_KEY_LINE_RE, MCP_SERVERS_KEY_LINE_RE, KOMBAI_TABLE_HEADER_RE, COMMAND_OR_ARGS_RE;
|
|
2068
2057
|
var init_codexKombaiEntry = __esm({
|
|
2069
2058
|
"../shared/src/mcp/codexKombaiEntry.ts"() {
|
|
2070
2059
|
"use strict";
|
|
2071
2060
|
init_define_KOMBAI_TELEMETRY();
|
|
2072
2061
|
init_chatMcpRegistrationArg();
|
|
2073
|
-
init_kombaiCliVersion();
|
|
2074
2062
|
KOMBAI_MCP_KEY = "kombai";
|
|
2075
2063
|
KOMBAI_CLI_MCP_COMMAND = "npx";
|
|
2064
|
+
KOMBAI_CLI_PACKAGE = "@kombai/cli@latest";
|
|
2076
2065
|
WINDOWS_SHELL_WRAPPER = ["cmd", "/c"];
|
|
2077
2066
|
KOMBAI_CLI_PACKAGE_RE = /^@kombai(?:-io)?\/cli(?:@[A-Za-z0-9._-]+)?$/;
|
|
2078
2067
|
LEGACY_LAUNCHER_RE = /[\\/]+\.kombai[\\/]+bin[\\/]+mcp-gateway(?:\.cmd)?(?=$|")/;
|
|
@@ -2104,12 +2093,12 @@ var init_version = __esm({
|
|
|
2104
2093
|
"use strict";
|
|
2105
2094
|
init_define_KOMBAI_TELEMETRY();
|
|
2106
2095
|
init_codexKombaiEntry();
|
|
2107
|
-
CLI_VERSION = true ? "0.1.5
|
|
2096
|
+
CLI_VERSION = true ? "0.1.5" : (
|
|
2108
2097
|
/** @type {{ version: string }} */
|
|
2109
2098
|
JSON.parse(readFileSync(new URL("../../package.json", import.meta.url), "utf8")).version
|
|
2110
2099
|
);
|
|
2111
|
-
CLI_RUN = true ? "npx -y @kombai/cli@0.1.5
|
|
2112
|
-
CLI_PACKAGE = true ? "@kombai/cli@0.1.5
|
|
2100
|
+
CLI_RUN = true ? "npx -y @kombai/cli@0.1.5" : `npx -y ${KOMBAI_CLI_PACKAGE}`;
|
|
2101
|
+
CLI_PACKAGE = true ? "@kombai/cli@0.1.5" : KOMBAI_CLI_PACKAGE;
|
|
2113
2102
|
CLI_OUTDATED_NEXT = "A newer Kombai CLI is out; update the Kombai plugin.";
|
|
2114
2103
|
}
|
|
2115
2104
|
});
|
|
@@ -35301,7 +35290,7 @@ var init_drawings = __esm({
|
|
|
35301
35290
|
var faq_default;
|
|
35302
35291
|
var init_faq = __esm({
|
|
35303
35292
|
"src/skill/faq.md"() {
|
|
35304
|
-
faq_default = "# Questions about Kombai\n\nAnswer the user's question from this text, briefly and in your own words. To answer, run only commands that\nchange nothing (`kombai whoami`, `kombai credits`, `kombai canvas list`). If the answer is not here, say so and\npoint them to support@kombai.com; don't guess. For design work, run `kombai skill` and follow it.\n\n## What Kombai is\n\n- **What it does.** Kombai is an AI design engineer. The coding agent runs the Kombai CLI: Kombai's taste agent\n writes design directions grounded in the user's brief and repo, and the agent builds each design as HTML on a\n hosted Kombai canvas, where the user compares, edits and refines the designs in the browser.\n- **Which agents.** Claude Code, Codex, Cursor, VS Code (GitHub Copilot's agent plugins) and Antigravity have\n Kombai plugins, and Gemini CLI has a Kombai extension; any agent with a terminal can run the CLI. The Codex app\n shows the canvas beside the chat and Kombai's cards (a taste run's brief, sign-in); the Claude desktop app's Code\n tab shows the taste card only. Elsewhere the canvas opens in the agent's own browser panel or the browser.\n- **The Kombai desktop app** is not needed: the CLI designs on a hosted canvas whether or not it is installed.\n- **Requirements.** Node.js 20 or later, and a Kombai account or guest mode. Thumbnails need a Chromium browser\n (Chrome, Edge, Brave, Arc or Chromium); without one, `kombai browser install` downloads a headless Chromium of\n about 100 MB, after asking.\n\n## Account and credits\n\n- **Without an account.** `kombai guest` gives one canvas, with no taste runs, repo images, design systems or\n sharing. The guest canvas ends on the date `kombai whoami` shows; signing in keeps it.\n- **Signing in.** `kombai login` shows a match code and opens a Kombai page in the browser, or in the agent's own\n browser panel: approve there only if the codes match. `kombai whoami` shows who is signed in. `kombai logout`\n signs this machine out; `kombai logout --everywhere` also signs out every other key, the Kombai app and the website.\n- **Credits.** Taste runs spend Kombai credits; `kombai credits` shows what is left, the plan and when it refills.\n On a team plan they are the team's shared pool. With none left, its next is the plans page. The designs\n themselves are written by the user's own coding agent, on that agent's usage.\n- **Organizations.** With several, `kombai config org <id>` sets which one owns new canvases and design systems.\n\n## Designs and data\n\n- **Where designs live.** On hosted canvases in the user's Kombai account. `kombai canvas list` lists every\n one (`--project <id>` one project's; this repo's carry its `checkoutProjectId`), and\n `kombai skill opening` says how to show one to the user.\n- **Editing.** The user can edit text, styles and layout on the canvas, or ask for a change from it: the canvas\n gives them a request to paste into this chat.\n- **Into code.** Ask the agent to build a design in this project: it writes it in the repo's own framework,\n components and styles, with the design as the reference.\n- **Design systems** are .ds files in the Kombai account and need no canvas; `kombai ds list` lists them.\n- **Sharing.** A new canvas is private. `kombai canvas share --canvas <id> --on` lets anyone with the link view it\n and teammates edit it; `--off` turns that off. Only the canvas's owner can.\n- **What Kombai receives.** The brief the agent writes for a taste run, each design's HTML, the repo images a\n design uses, files the agent uploads, design systems it pushes, and the thumbnails rendered on this machine.\n The rest of the repo is not uploaded.\n- **What stays here.** The sign-in key and the working copies of canvases, under ~/.kombai/cli.\n- **Usage data.** The CLI sends Kombai an event for each command (which ran, how it ended, how long it took) and\n reports unexpected errors. `DO_NOT_TRACK=1` turns both off.\n- **Deleting.** `kombai canvas delete --canvas <id>` and `kombai ds delete <slug>` delete for everyone. Deleting\n ~/.kombai removes what is stored on this machine. To close the account, email support@kombai.com.\n\n## Setup and problems\n\n- **Permissions.** Kombai needs network access and writes ~/.kombai, so an agent with a sandbox asks to run it\n outside.\n- **The desktop app's skills.** The first Kombai command on a machine removes the skills the Kombai desktop app\n wrote into the agents' skills folders (`design-with-kombai`, `kombai-faq`, `kombai-status` and the rest), which\n drive the app instead of the CLI. Only the app's own copies go; other skills, the user's own included, stay. An\n agent session that was already open lists them until it restarts.\n- **Updates.** The Kombai plugin pins the CLI version, so the CLI updates when the plugin updates, through the\n agent's own plugin manager. A global
|
|
35293
|
+
faq_default = "# Questions about Kombai\n\nAnswer the user's question from this text, briefly and in your own words. To answer, run only commands that\nchange nothing (`kombai whoami`, `kombai credits`, `kombai canvas list`). If the answer is not here, say so and\npoint them to support@kombai.com; don't guess. For design work, run `kombai skill` and follow it.\n\n## What Kombai is\n\n- **What it does.** Kombai is an AI design engineer. The coding agent runs the Kombai CLI: Kombai's taste agent\n writes design directions grounded in the user's brief and repo, and the agent builds each design as HTML on a\n hosted Kombai canvas, where the user compares, edits and refines the designs in the browser.\n- **Which agents.** Claude Code, Codex, Cursor, VS Code (GitHub Copilot's agent plugins) and Antigravity have\n Kombai plugins, and Gemini CLI has a Kombai extension; any agent with a terminal can run the CLI. The Codex app\n shows the canvas beside the chat and Kombai's cards (a taste run's brief, sign-in); the Claude desktop app's Code\n tab shows the taste card only. Elsewhere the canvas opens in the agent's own browser panel or the browser.\n- **The Kombai desktop app** is not needed: the CLI designs on a hosted canvas whether or not it is installed.\n- **Requirements.** Node.js 20 or later, and a Kombai account or guest mode. Thumbnails need a Chromium browser\n (Chrome, Edge, Brave, Arc or Chromium); without one, `kombai browser install` downloads a headless Chromium of\n about 100 MB, after asking.\n\n## Account and credits\n\n- **Without an account.** `kombai guest` gives one canvas, with no taste runs, repo images, design systems or\n sharing. The guest canvas ends on the date `kombai whoami` shows; signing in keeps it.\n- **Signing in.** `kombai login` shows a match code and opens a Kombai page in the browser, or in the agent's own\n browser panel: approve there only if the codes match. `kombai whoami` shows who is signed in. `kombai logout`\n signs this machine out; `kombai logout --everywhere` also signs out every other key, the Kombai app and the website.\n- **Credits.** Taste runs spend Kombai credits; `kombai credits` shows what is left, the plan and when it refills.\n On a team plan they are the team's shared pool. With none left, its next is the plans page. The designs\n themselves are written by the user's own coding agent, on that agent's usage.\n- **Organizations.** With several, `kombai config org <id>` sets which one owns new canvases and design systems.\n\n## Designs and data\n\n- **Where designs live.** On hosted canvases in the user's Kombai account. `kombai canvas list` lists every\n one (`--project <id>` one project's; this repo's carry its `checkoutProjectId`), and\n `kombai skill opening` says how to show one to the user.\n- **Editing.** The user can edit text, styles and layout on the canvas, or ask for a change from it: the canvas\n gives them a request to paste into this chat.\n- **Into code.** Ask the agent to build a design in this project: it writes it in the repo's own framework,\n components and styles, with the design as the reference.\n- **Design systems** are .ds files in the Kombai account and need no canvas; `kombai ds list` lists them.\n- **Sharing.** A new canvas is private. `kombai canvas share --canvas <id> --on` lets anyone with the link view it\n and teammates edit it; `--off` turns that off. Only the canvas's owner can.\n- **What Kombai receives.** The brief the agent writes for a taste run, each design's HTML, the repo images a\n design uses, files the agent uploads, design systems it pushes, and the thumbnails rendered on this machine.\n The rest of the repo is not uploaded.\n- **What stays here.** The sign-in key and the working copies of canvases, under ~/.kombai/cli.\n- **Usage data.** The CLI sends Kombai an event for each command (which ran, how it ended, how long it took) and\n reports unexpected errors. `DO_NOT_TRACK=1` turns both off.\n- **Deleting.** `kombai canvas delete --canvas <id>` and `kombai ds delete <slug>` delete for everyone. Deleting\n ~/.kombai removes what is stored on this machine. To close the account, email support@kombai.com.\n\n## Setup and problems\n\n- **Permissions.** Kombai needs network access and writes ~/.kombai, so an agent with a sandbox asks to run it\n outside.\n- **The desktop app's skills.** The first Kombai command on a machine removes the skills the Kombai desktop app\n wrote into the agents' skills folders (`design-with-kombai`, `kombai-faq`, `kombai-status` and the rest), which\n drive the app instead of the CLI. Only the app's own copies go; other skills, the user's own included, stay. An\n agent session that was already open lists them until it restarts.\n- **Updates.** The Kombai plugin pins the CLI version, so the CLI updates when the plugin updates, through the\n agent's own plugin manager. The skill the Kombai desktop app installs starts from the newest release. A global\n install updates with npm.\n- **Reporting a problem.** Email support@kombai.com with the command, the JSON line it printed and the version\n `kombai --version` prints.\n";
|
|
35305
35294
|
}
|
|
35306
35295
|
});
|
|
35307
35296
|
|
package/package.json
CHANGED