Skip to content
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
34 changes: 17 additions & 17 deletions site/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>Not found deepseek-cli</title>
<title>Not found: deepseek-cli</title>
<meta name="description" content="That page does not exist. The deepseek-cli documentation index.">
<meta name="keywords" content="deepseek cli">
<meta name="author" content="thevibeworks">
Expand All @@ -12,15 +12,15 @@
<meta name="robots" content="noindex, follow">
<meta property="og:type" content="website">
<meta property="og:site_name" content="deepseek-cli">
<meta property="og:title" content="Not found deepseek-cli">
<meta property="og:title" content="Not found: deepseek-cli">
<meta property="og:description" content="That page does not exist. The deepseek-cli documentation index.">
<meta property="og:url" content="https://thevibeworks.github.io/deepseek-cli/">
<meta property="og:image" content="https://thevibeworks.github.io/deepseek-cli/og.png">
<meta property="og:image:width" content="1200">
<meta property="og:image:height" content="630">
<meta property="og:image:alt" content="deepseek-cli the whole DeepSeek API from the terminal">
<meta property="og:image:alt" content="deepseek-cli: the whole DeepSeek API from the terminal">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="Not found deepseek-cli">
<meta name="twitter:title" content="Not found: deepseek-cli">
<meta name="twitter:description" content="That page does not exist. The deepseek-cli documentation index.">
<meta name="twitter:image" content="https://thevibeworks.github.io/deepseek-cli/og.png">
<link rel="icon" href="https://thevibeworks.github.io/deepseek-cli/favicon.svg" type="image/svg+xml">
Expand Down Expand Up @@ -59,8 +59,8 @@
<a class="brand" href="https://thevibeworks.github.io/deepseek-cli/">
<span class="caret">&gt;</span><svg class="mark" viewBox="0 0 63.1196 46.4033" width="23" height="17" aria-hidden="true"><path d="M62.4575 3.89441C61.7888 3.56726 61.501 4.1908 61.1101 4.50769C60.9763 4.60999 60.863 4.7428 60.75 4.86548C59.7727 5.9082 58.6311 6.59302 57.1394 6.51123C54.9587 6.38855 53.0969 7.07349 51.4512 8.73975C51.1013 6.68506 49.939 5.45837 48.1699 4.67126C47.2441 4.26233 46.3081 3.85352 45.6599 2.96411C45.2073 2.33032 45.084 1.625 44.8577 0.929932C44.7136 0.510864 44.5696 0.081543 44.0862 0.0098877C43.5615 -0.0718994 43.3557 0.367676 43.1501 0.735718C42.3271 2.2384 42.0083 3.89441 42.0391 5.5708C42.1111 9.34277 43.7056 12.3481 46.8738 14.4846C47.2336 14.73 47.3264 14.9753 47.2131 15.333C46.9971 16.0691 46.74 16.7847 46.5137 17.5206C46.3696 17.9908 46.1538 18.093 45.6497 17.8887C43.9114 17.1628 42.4094 16.0895 41.0825 14.7913C38.8298 12.6139 36.7932 10.2117 34.2524 8.33081C33.6558 7.89124 33.0593 7.48242 32.4421 7.09399C29.8499 4.57922 32.7815 2.5144 33.4604 2.26904C34.1702 2.01343 33.7073 1.1344 31.4133 1.14465C29.1196 1.15479 27.0212 1.92151 24.3467 2.94373C23.9558 3.09705 23.5444 3.20947 23.1226 3.30151C20.6951 2.84143 18.1748 2.73926 15.5415 3.03577C10.5835 3.58777 6.62329 5.92859 3.7124 9.92554C0.215088 14.73 -0.60791 20.1886 0.400146 25.8824C1.45972 31.8828 4.5249 36.8508 9.23608 40.7354C14.1221 44.7629 19.7488 46.7357 26.1675 46.3575C30.0659 46.1327 34.4067 45.6113 39.303 41.4713C40.5374 42.0847 41.8335 42.33 43.9834 42.514C45.6394 42.6674 47.2336 42.4323 48.468 42.1766C50.4019 41.7678 50.2683 39.9789 49.5688 39.6517C43.9009 37.0144 45.1455 38.0878 44.0142 37.2189C46.8943 33.8148 51.2351 30.278 52.9324 18.8188C53.0662 17.9091 52.9529 17.3367 52.9324 16.6006C52.9221 16.1509 53.0249 15.9771 53.5393 15.9259C54.9587 15.7625 56.3372 15.3739 57.6023 14.6788C61.2747 12.6753 62.7559 9.38367 63.1055 5.43799C63.157 4.83484 63.0952 4.2113 62.4575 3.89441ZM30.4568 39.4065C24.9639 35.0927 22.2998 33.6718 21.199 33.7332C20.1704 33.7944 20.3557 34.97 20.5818 35.7367C20.8186 36.493 21.1272 37.0144 21.5591 37.6788C21.8574 38.1184 22.0632 38.7727 21.2607 39.2633C19.4915 40.3571 16.416 38.8953 16.272 38.8237C12.6924 36.718 9.69897 33.9375 7.59033 30.1349C5.55347 26.4753 4.37061 22.5499 4.17529 18.3589C4.12378 17.3468 4.42212 16.989 5.43018 16.8051C6.75708 16.5597 8.12524 16.5087 9.45215 16.7029C15.0581 17.5206 19.8311 20.025 23.8323 23.9913C26.116 26.2504 27.844 28.9491 29.6235 31.5864C31.5164 34.3873 33.553 37.0553 36.145 39.2429C37.0605 40.0095 37.791 40.5922 38.4905 41.0215C36.3816 41.2567 32.8638 41.3077 30.4568 39.4065ZM33.0901 22.4886C33.0901 22.0388 33.4502 21.681 33.9026 21.681C34.0056 21.681 34.0981 21.7015 34.1804 21.7322C34.2935 21.7731 34.3965 21.8344 34.4788 21.9264C34.6228 22.0695 34.7051 22.2739 34.7051 22.4886C34.7051 22.9384 34.345 23.2961 33.8923 23.2961C33.4397 23.2961 33.0901 22.9384 33.0901 22.4886ZM41.2676 26.6798C40.7432 26.8944 40.2185 27.0784 39.7144 27.0989C38.9326 27.1398 38.0789 26.8229 37.616 26.4344C36.896 25.8313 36.3816 25.494 36.1658 24.441C36.073 23.9913 36.1245 23.2961 36.2068 22.8975C36.3921 22.0388 36.1863 21.4868 35.5793 20.986C35.0857 20.577 34.4583 20.4646 33.769 20.4646C33.5117 20.4646 33.2751 20.3522 33.1003 20.2601C32.8123 20.1171 32.5757 19.7593 32.802 19.3197C32.874 19.1766 33.2239 18.8291 33.3062 18.7677C34.2422 18.2362 35.3223 18.4099 36.3201 18.8086C37.2458 19.1869 37.9453 19.882 38.9534 20.8633C39.9819 22.0491 40.167 22.3762 40.7534 23.2655C41.2163 23.9607 41.6379 24.6761 41.926 25.494C42.1008 26.0051 41.8745 26.4242 41.2676 26.6798Z"/></svg><span class="org">thevibeworks/</span><span class="name">deepseek-cli</span>
</a>
<!-- Nav and toggle travel together they are the controls end of the
masthead but the toggle is beside the nav rather than inside it.
<!-- Nav and toggle travel together they are the controls end of the
masthead but the toggle is beside the nav rather than inside it.
Two reasons, and the second is the load-bearing one: a theme
preference is not a section of the site, and on a phone the nav
becomes a scrolling strip with a mask on it, which would take the
Expand Down Expand Up @@ -89,17 +89,17 @@
<div class="wrap">

<h1>404</h1>
<p class="lede">No such page &mdash; deep water. The whole site is eight of them:</p>
<p class="lede">No such page &ndash; deep water. The whole site is eight of them:</p>

<ul>
<li><a href="https://thevibeworks.github.io/deepseek-cli/">overview</a> &mdash; what it is and why</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/install/">install</a> &mdash; binaries, Go, the <code>ds</code> alias, configuration</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/commands/">commands</a> &mdash; every command and flag</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/formats/">formats</a> &mdash; DeepSeek's four wire formats compared</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/cost/">cost</a> &mdash; pricing, the context cache, the usage ledger</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/news/">news</a> &mdash; what is changing upstream, including the announced price rise</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/agents/">agents</a> &mdash; the scripting contract</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/playground/">playground</a> &mdash; the API in a browser, no key needed</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/">overview</a> &ndash; what it is and why</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/install/">install</a> &ndash; binaries, Go, the <code>ds</code> alias, configuration</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/commands/">commands</a> &ndash; every command and flag</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/formats/">formats</a> &ndash; DeepSeek's four wire formats compared</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/cost/">cost</a> &ndash; pricing, the context cache, the usage ledger</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/news/">news</a> &ndash; what is changing upstream, including the announced price rise</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/agents/">agents</a> &ndash; the scripting contract</li>
<li><a href="https://thevibeworks.github.io/deepseek-cli/playground/">playground</a> &ndash; the API in a browser, no key needed</li>
</ul>
<p><a href="https://thevibeworks.github.io/deepseek-cli/">&larr; back to the overview</a></p>
<nav class="pager" aria-label="Pagination">
Expand All @@ -115,7 +115,7 @@ <h1>404</h1>
<a href="https://thevibeworks.github.io/deepseek-cli/llms.txt">llms.txt</a> &middot;
<a href="https://thevibeworks.github.io/">thevibeworks</a>
</span>
<span>unofficial &mdash; not affiliated with DeepSeek</span>
<span>unofficial &ndash; not affiliated with DeepSeek</span>
</div>
</footer>
<script>
Expand All @@ -131,7 +131,7 @@ <h1>404</h1>
else document.documentElement.dataset.theme = v;
b.querySelector('.val').textContent = v;
// The button reads "theme: dark" to a screen reader, and announcing
// the change is the whole feedback the visual change is silent.
// the change is the whole feedback the visual change is silent.
b.setAttribute('aria-label', 'Theme: ' + v + '. Click to change.');
};
b.hidden = false;
Expand Down
24 changes: 12 additions & 12 deletions site/agents/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>deepseek-cli for agents and scripts the output contract</title>
<title>deepseek-cli for agents and scripts: the output contract</title>
<meta name="description" content="How to drive the deepseek CLI from code: stdout/stderr split, unwrapped --json responses, per-format JSON shapes, meaningful exit codes, retry semantics, and a drop-in agent skill.">
<meta name="keywords" content="deepseek cli scripting, deepseek cli json output, deepseek agent skill, deepseek cli exit codes, llm cli automation, deepseek jq">
<meta name="author" content="thevibeworks">
Expand All @@ -12,15 +12,15 @@
<link rel="canonical" href="https://thevibeworks.github.io/deepseek-cli/agents/">
<meta property="og:type" content="website">
<meta property="og:site_name" content="deepseek-cli">
<meta property="og:title" content="deepseek-cli for agents and scripts the output contract">
<meta property="og:title" content="deepseek-cli for agents and scripts: the output contract">
<meta property="og:description" content="How to drive the deepseek CLI from code: stdout/stderr split, unwrapped --json responses, per-format JSON shapes, meaningful exit codes, retry semantics, and a drop-in agent skill.">
<meta property="og:url" content="https://thevibeworks.github.io/deepseek-cli/agents/">
<meta property="og:image" content="https://thevibeworks.github.io/deepseek-cli/og.png">
<meta property="og:image:width" content="1200">
<meta property="og:image:height" content="630">
<meta property="og:image:alt" content="deepseek-cli the whole DeepSeek API from the terminal">
<meta property="og:image:alt" content="deepseek-cli: the whole DeepSeek API from the terminal">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="deepseek-cli for agents and scripts the output contract">
<meta name="twitter:title" content="deepseek-cli for agents and scripts: the output contract">
<meta name="twitter:description" content="How to drive the deepseek CLI from code: stdout/stderr split, unwrapped --json responses, per-format JSON shapes, meaningful exit codes, retry semantics, and a drop-in agent skill.">
<meta name="twitter:image" content="https://thevibeworks.github.io/deepseek-cli/og.png">
<link rel="icon" href="../favicon.svg" type="image/svg+xml">
Expand Down Expand Up @@ -54,8 +54,8 @@
<a class="brand" href="../">
<span class="caret">&gt;</span><svg class="mark" viewBox="0 0 63.1196 46.4033" width="23" height="17" aria-hidden="true"><path d="M62.4575 3.89441C61.7888 3.56726 61.501 4.1908 61.1101 4.50769C60.9763 4.60999 60.863 4.7428 60.75 4.86548C59.7727 5.9082 58.6311 6.59302 57.1394 6.51123C54.9587 6.38855 53.0969 7.07349 51.4512 8.73975C51.1013 6.68506 49.939 5.45837 48.1699 4.67126C47.2441 4.26233 46.3081 3.85352 45.6599 2.96411C45.2073 2.33032 45.084 1.625 44.8577 0.929932C44.7136 0.510864 44.5696 0.081543 44.0862 0.0098877C43.5615 -0.0718994 43.3557 0.367676 43.1501 0.735718C42.3271 2.2384 42.0083 3.89441 42.0391 5.5708C42.1111 9.34277 43.7056 12.3481 46.8738 14.4846C47.2336 14.73 47.3264 14.9753 47.2131 15.333C46.9971 16.0691 46.74 16.7847 46.5137 17.5206C46.3696 17.9908 46.1538 18.093 45.6497 17.8887C43.9114 17.1628 42.4094 16.0895 41.0825 14.7913C38.8298 12.6139 36.7932 10.2117 34.2524 8.33081C33.6558 7.89124 33.0593 7.48242 32.4421 7.09399C29.8499 4.57922 32.7815 2.5144 33.4604 2.26904C34.1702 2.01343 33.7073 1.1344 31.4133 1.14465C29.1196 1.15479 27.0212 1.92151 24.3467 2.94373C23.9558 3.09705 23.5444 3.20947 23.1226 3.30151C20.6951 2.84143 18.1748 2.73926 15.5415 3.03577C10.5835 3.58777 6.62329 5.92859 3.7124 9.92554C0.215088 14.73 -0.60791 20.1886 0.400146 25.8824C1.45972 31.8828 4.5249 36.8508 9.23608 40.7354C14.1221 44.7629 19.7488 46.7357 26.1675 46.3575C30.0659 46.1327 34.4067 45.6113 39.303 41.4713C40.5374 42.0847 41.8335 42.33 43.9834 42.514C45.6394 42.6674 47.2336 42.4323 48.468 42.1766C50.4019 41.7678 50.2683 39.9789 49.5688 39.6517C43.9009 37.0144 45.1455 38.0878 44.0142 37.2189C46.8943 33.8148 51.2351 30.278 52.9324 18.8188C53.0662 17.9091 52.9529 17.3367 52.9324 16.6006C52.9221 16.1509 53.0249 15.9771 53.5393 15.9259C54.9587 15.7625 56.3372 15.3739 57.6023 14.6788C61.2747 12.6753 62.7559 9.38367 63.1055 5.43799C63.157 4.83484 63.0952 4.2113 62.4575 3.89441ZM30.4568 39.4065C24.9639 35.0927 22.2998 33.6718 21.199 33.7332C20.1704 33.7944 20.3557 34.97 20.5818 35.7367C20.8186 36.493 21.1272 37.0144 21.5591 37.6788C21.8574 38.1184 22.0632 38.7727 21.2607 39.2633C19.4915 40.3571 16.416 38.8953 16.272 38.8237C12.6924 36.718 9.69897 33.9375 7.59033 30.1349C5.55347 26.4753 4.37061 22.5499 4.17529 18.3589C4.12378 17.3468 4.42212 16.989 5.43018 16.8051C6.75708 16.5597 8.12524 16.5087 9.45215 16.7029C15.0581 17.5206 19.8311 20.025 23.8323 23.9913C26.116 26.2504 27.844 28.9491 29.6235 31.5864C31.5164 34.3873 33.553 37.0553 36.145 39.2429C37.0605 40.0095 37.791 40.5922 38.4905 41.0215C36.3816 41.2567 32.8638 41.3077 30.4568 39.4065ZM33.0901 22.4886C33.0901 22.0388 33.4502 21.681 33.9026 21.681C34.0056 21.681 34.0981 21.7015 34.1804 21.7322C34.2935 21.7731 34.3965 21.8344 34.4788 21.9264C34.6228 22.0695 34.7051 22.2739 34.7051 22.4886C34.7051 22.9384 34.345 23.2961 33.8923 23.2961C33.4397 23.2961 33.0901 22.9384 33.0901 22.4886ZM41.2676 26.6798C40.7432 26.8944 40.2185 27.0784 39.7144 27.0989C38.9326 27.1398 38.0789 26.8229 37.616 26.4344C36.896 25.8313 36.3816 25.494 36.1658 24.441C36.073 23.9913 36.1245 23.2961 36.2068 22.8975C36.3921 22.0388 36.1863 21.4868 35.5793 20.986C35.0857 20.577 34.4583 20.4646 33.769 20.4646C33.5117 20.4646 33.2751 20.3522 33.1003 20.2601C32.8123 20.1171 32.5757 19.7593 32.802 19.3197C32.874 19.1766 33.2239 18.8291 33.3062 18.7677C34.2422 18.2362 35.3223 18.4099 36.3201 18.8086C37.2458 19.1869 37.9453 19.882 38.9534 20.8633C39.9819 22.0491 40.167 22.3762 40.7534 23.2655C41.2163 23.9607 41.6379 24.6761 41.926 25.494C42.1008 26.0051 41.8745 26.4242 41.2676 26.6798Z"/></svg><span class="org">thevibeworks/</span><span class="name">deepseek-cli</span>
</a>
<!-- Nav and toggle travel together they are the controls end of the
masthead but the toggle is beside the nav rather than inside it.
<!-- Nav and toggle travel together they are the controls end of the
masthead but the toggle is beside the nav rather than inside it.
Two reasons, and the second is the load-bearing one: a theme
preference is not a section of the site, and on a phone the nav
becomes a scrolling strip with a mask on it, which would take the
Expand Down Expand Up @@ -107,7 +107,7 @@ <h2 id="json">--json is not wrapped</h2>
<pre><code>ds chat "..." --json | jq -r '.choices[0].message.content'
ds chat "..." --jq '.usage'
ds models --json | jq -r '.data[].id'</code></pre>
<p>Cost deliberately does not appear there &mdash; it would have meant wrapping
<p>Cost deliberately does not appear there &ndash; it would have meant wrapping
the response. It goes to stderr and to the
<a href="../cost/">ledger</a> instead.</p>

Expand Down Expand Up @@ -141,7 +141,7 @@ <h2 id="exit">Exit codes carry meaning</h2>
<p>Transport failures and 429/5xx are already retried internally with
exponential backoff, honouring <code>Retry-After</code>. A non-zero exit means
your own retry loop probably will not help either. Requests that reached the
model are never retried &mdash; a second call would be billed twice.</p>
model are never retried &ndash; a second call would be billed twice.</p>

<h2 id="preflight">Preflight</h2>
<pre><code>ds check --json
Expand All @@ -152,7 +152,7 @@ <h2 id="preflight">Preflight</h2>
<h2 id="errors">Errors say what to do</h2>
<pre><code>$ ds chat hi
Error: Insufficient Balance (HTTP 402)
out of balance: deepseek balance &mdash; top up at https://platform.deepseek.com/top_up</code></pre>
out of balance: deepseek balance &ndash; top up at https://platform.deepseek.com/top_up</code></pre>

<h2 id="quiet">Quiet mode</h2>
<pre><code>ds chat "..." --no-stats --no-ledger --json</code></pre>
Expand All @@ -165,7 +165,7 @@ <h2 id="skill">As an agent skill</h2>
the rules that matter for autonomous use:</p>
<ul>
<li>Report costs as estimates, never as billed amounts.</li>
<li>Do not retry on exit 2 or 3 &mdash; bring them to the human.</li>
<li>Do not retry on exit 2 or 3 &ndash; bring them to the human.</li>
<li>The API is text-only: no images, no documents.</li>
<li>Slow starts of up to ten minutes are normal under load, not a failure.</li>
</ul>
Expand All @@ -182,7 +182,7 @@ <h2 id="skill">As an agent skill</h2>
<a href="https://thevibeworks.github.io/deepseek-cli/llms.txt">llms.txt</a> &middot;
<a href="https://thevibeworks.github.io/">thevibeworks</a>
</span>
<span>unofficial &mdash; not affiliated with DeepSeek</span>
<span>unofficial &ndash; not affiliated with DeepSeek</span>
</div>
</footer>
<script>
Expand All @@ -198,7 +198,7 @@ <h2 id="skill">As an agent skill</h2>
else document.documentElement.dataset.theme = v;
b.querySelector('.val').textContent = v;
// The button reads "theme: dark" to a screen reader, and announcing
// the change is the whole feedback the visual change is silent.
// the change is the whole feedback the visual change is silent.
b.setAttribute('aria-label', 'Theme: ' + v + '. Click to change.');
};
b.hidden = false;
Expand Down
Loading