Skip to content
This repository was archived by the owner on Jun 1, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/app/src/i18n/ja.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,14 +132,14 @@ const translated = {
"provider.connect.apiKey.label": "{{provider}} APIキー",
"provider.connect.apiKey.placeholder": "APIキー",
"provider.connect.apiKey.required": "APIキーが必要です",
"provider.connect.oauth.code.visit.prefix": " ",
"provider.connect.oauth.code.visit.prefix": "アクセス: ",
"provider.connect.oauth.code.visit.link": "このリンク",
"provider.connect.oauth.code.visit.suffix": " にアクセスして認証コードを取得し、アカウントを接続してCodeplaneで{{provider}}モデルを使用してください。",
"provider.connect.oauth.code.label": "{{method}} 認証コード",
"provider.connect.oauth.code.placeholder": "認証コード",
"provider.connect.oauth.code.required": "認証コードが必要です",
"provider.connect.oauth.code.invalid": "無効な認証コード",
"provider.connect.oauth.auto.visit.prefix": " ",
"provider.connect.oauth.auto.visit.prefix": "アクセス: ",
"provider.connect.oauth.auto.visit.link": "このリンク",
"provider.connect.oauth.auto.visit.suffix": " にアクセスし、以下のコードを入力してアカウントを接続し、Codeplaneで{{provider}}モデルを使用してください。",
"provider.connect.oauth.auto.confirmationCode": "確認コード",
Expand Down
4 changes: 2 additions & 2 deletions packages/ui/src/i18n/ja.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ const translated = {
"ui.fileMedia.binary.title": "バイナリファイル",
"ui.fileMedia.binary.description.path": "{{path}} はバイナリファイルのため表示できません。",
"ui.fileMedia.binary.description.default": "このファイルはバイナリファイルのため表示できません。",
"ui.lineComment.label.prefix": "",
"ui.lineComment.label.prefix": "行目: ",
"ui.lineComment.label.suffix": "へのコメント",
"ui.lineComment.editorLabel.prefix": "",
"ui.lineComment.editorLabel.prefix": "コメント編集中: ",
"ui.lineComment.editorLabel.suffix": "へのコメントを作成中",
"ui.lineComment.placeholder": "コメントを追加",
"ui.lineComment.submit": "コメント",
Expand Down
4 changes: 2 additions & 2 deletions packages/ui/src/i18n/ko.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ const translated = {
"ui.fileMedia.binary.title": "바이너리 파일",
"ui.fileMedia.binary.description.path": "{{path}}은(는) 바이너리 파일이므로 표시할 수 없습니다.",
"ui.fileMedia.binary.description.default": "바이너리 파일이므로 표시할 수 없습니다.",
"ui.lineComment.label.prefix": "",
"ui.lineComment.label.prefix": "라인 ",
"ui.lineComment.label.suffix": "에 댓글 달기",
"ui.lineComment.editorLabel.prefix": "",
"ui.lineComment.editorLabel.prefix": "편집 중 ",
"ui.lineComment.editorLabel.suffix": "에 댓글 작성 중",
"ui.lineComment.placeholder": "댓글 추가",
"ui.lineComment.submit": "댓글",
Expand Down
26 changes: 20 additions & 6 deletions site/app/docs/cli/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ import { DocsLayout } from "@/components/docs-sidebar"

export const metadata = {
title: "CLI reference",
description: "Every Codeplane subcommand and flag, sourced from packages/codeplane/src/cli — serve, web, tui, instance, upgrade, completion.",
description: "Every Codeplane subcommand and flag, sourced from packages/codeplane/src/cli — serve, web, tui, instance, upgrade, totp, completion.",
alternates: { canonical: "/docs/cli/" },
openGraph: {
title: "CLI reference · Codeplane",
description: "Every Codeplane subcommand and flag, sourced from packages/codeplane/src/cli — serve, web, tui, instance, upgrade, completion.",
description: "Every Codeplane subcommand and flag, sourced from packages/codeplane/src/cli — serve, web, tui, instance, upgrade, totp, completion.",
url: "/docs/cli/",
type: "article",
},
twitter: {
title: "CLI reference · Codeplane",
description: "Every Codeplane subcommand and flag, sourced from packages/codeplane/src/cli — serve, web, tui, instance, upgrade, completion.",
description: "Every Codeplane subcommand and flag, sourced from packages/codeplane/src/cli — serve, web, tui, instance, upgrade, totp, completion.",
card: "summary_large_image",
},
}
Expand All @@ -41,6 +41,8 @@ Commands:
tui start the terminal UI
instance manage saved Codeplane instances + the shared local runtime
upgrade [target] upgrade Codeplane to the latest (or a specific) version
totp <command> manage two-factor (TOTP) auth for the server
generate regenerate the OpenAPI spec (SDK build pipeline)
completion generate shell completion script
Comment on lines +45 to 46

Top-level options (accepted by every subcommand):
Expand Down Expand Up @@ -110,6 +112,18 @@ Top-level options (accepted by every subcommand):
<code>instance-daemon.ts</code>. New flags land in code first, then on this page.
</p>

<h2><code>codeplane totp</code></h2>
<p>Manage the second factor for <code>serve</code> / <code>web</code>. The generated secret is
passed via <code>CODEPLANE_SERVER_TOTP_SECRET</code> or <code>--totp-secret</code>.</p>
<pre><code>{`codeplane totp <subcommand>

generate generate a new TOTP secret and enrolment URI
flags: --account, --issuer
uri --secret &lt;s&gt; print the otpauth:// URI for an existing secret
flags: --secret, --account, --issuer
code --secret &lt;s&gt; print the current 6-digit code (debug)
flags: --secret`}</code></pre>

<h2><code>codeplane upgrade</code></h2>
<pre><code>{`codeplane upgrade [target]

Expand Down Expand Up @@ -163,9 +177,9 @@ codeplane completion fish > ~/.config/fish/completions/codeplane.fish`}</code></

<h2>Generated and hidden commands</h2>
<p>
<code>codeplane generate</code> is intentionally hidden from normal help. It is used by
the SDK build pipeline to emit OpenAPI data for client generation. Treat it as a build
command, not a public automation API.
<code>codeplane generate</code> is hidden from normal help (<code>describe: false</code>).
It is used by the SDK build pipeline to emit OpenAPI data for client generation. Treat it
as a build command, not a public automation API.
</p>

<h2>Exit codes</h2>
Expand Down
25 changes: 24 additions & 1 deletion site/app/docs/configuration/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ export default function Configuration() {
"server": { /* default serve/web network options */ },
"model": "anthropic/claude-sonnet-4-6",
"small_model": "openai/gpt-5.2-mini",
"disabled_providers": ["example-provider"],
"enabled_providers": ["anthropic", "openai"],
"provider": { /* model providers and overrides */ },
"permission": { /* what the agent may do without asking */ },
"agent": { /* named primary and sub-agent configs */ },
Expand All @@ -72,8 +74,12 @@ export default function Configuration() {
"commit": { "coauthor": false },
"autoupdate": "notify",
"share": "manual",
"username": "custom-display-name",
"default_agent": "build",
"npm": { /* native npm auth and registry settings */ },
"watcher": { "ignore": ["node_modules/", "dist/"] },
"tool_output": { "max_lines": 2000, "max_bytes": 51200 },
"compaction": { "auto": true, "prune": true }
"compaction": { "auto": true, "prune": true, "tail_turns": 2, "reserved": 1000 }
}`}</code></pre>

<h2>server</h2>
Expand Down Expand Up @@ -127,6 +133,17 @@ export default function Configuration() {
OpenAI-compatible endpoints.
</p>

<h2>npm</h2>
<pre><code>{`"npm": {
"registry": "https://registry.npmjs.org",
"authToken": "{secret:npm-auth-token}"
}`}</code></pre>
<p>
Override the npm registry and supply an auth token for private registries. Used by the
local-runtime downloader and any plugin that shells out to npm. Values support{" "}
<code>{`{secret:name}`}</code> and <code>{`{env:VAR}`}</code> placeholders.
</p>

<h2>permission</h2>
<pre><code>{`"permission": {
"read": "allow",
Expand Down Expand Up @@ -264,14 +281,20 @@ export default function Configuration() {
<table>
<thead><tr><th>Key</th><th>Values</th><th>Use it for</th></tr></thead>
<tbody>
<tr><td><code>username</code></td><td>string</td><td>Custom name shown in conversations instead of the system username.</td></tr>
<tr><td><code>default_agent</code></td><td>string</td><td>Primary agent to use when none is specified (falls back to <code>build</code>).</td></tr>
<tr><td><code>share</code></td><td><code>manual</code>, <code>auto</code>, <code>disabled</code></td><td>Control public session sharing.</td></tr>
<tr><td><code>autoupdate</code></td><td><code>true</code>, <code>false</code>, <code>notify</code></td><td>Auto-install patches or show update notifications.</td></tr>
<tr><td><code>commit.coauthor</code></td><td><code>true</code>, <code>false</code></td><td>Add <code>Co-Authored-By: codeplane-agent[bot] &lt;287208015+codeplane-agent[bot]@users.noreply.github.com&gt;</code> so GitHub shows the <a href="https://github.com/apps/codeplane-agent">codeplane-agent app</a> as a co-author.</td></tr>
<tr><td><code>snapshot</code></td><td><code>true</code>, <code>false</code></td><td>Enable filesystem snapshots for revert/undo.</td></tr>
<tr><td><code>disabled_providers</code></td><td>string array</td><td>Catalog providers to hide from the model selector.</td></tr>
<tr><td><code>enabled_providers</code></td><td>string array</td><td>When set, only these providers are loaded; all others are ignored.</td></tr>
<tr><td><code>tool_output.max_lines</code></td><td>positive integer</td><td>Truncate long tool output previews after this many lines.</td></tr>
<tr><td><code>tool_output.max_bytes</code></td><td>positive integer</td><td>Truncate long tool output previews after this many bytes.</td></tr>
<tr><td><code>compaction.auto</code></td><td><code>true</code>, <code>false</code></td><td>Compact automatically when context is full.</td></tr>
<tr><td><code>compaction.prune</code></td><td><code>true</code>, <code>false</code></td><td>Prune old tool outputs during compaction.</td></tr>
<tr><td><code>compaction.tail_turns</code></td><td>non-negative integer</td><td>Number of recent user turns to keep verbatim during compaction (default: 2).</td></tr>
<tr><td><code>compaction.reserved</code></td><td>non-negative integer</td><td>Token buffer to leave free so compaction does not overflow the context window.</td></tr>
</tbody>
</table>

Expand Down
Loading