Skip to content

Commit d35e98b

Browse files
committed
docs.
Signed-off-by: Jose Alekhinne <jose@ctx.ist>
1 parent 448f68a commit d35e98b

9 files changed

Lines changed: 8470 additions & 29 deletions

File tree

site/cli/index.html

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3646,6 +3646,10 @@ <h2 id="global-options">Global Options<a class="headerlink" href="#global-option
36463646
<td><code>--allow-outside-cwd</code></td>
36473647
<td>Allow context directory outside current working directory</td>
36483648
</tr>
3649+
<tr>
3650+
<td><code>--tool &lt;name&gt;</code></td>
3651+
<td>Override active AI tool identifier (e.g. <code>kiro</code>, <code>cursor</code>)</td>
3652+
</tr>
36493653
</tbody>
36503654
</table>
36513655
<p><strong>Initialization required.</strong> Most commands require a <code>.context/</code> directory
@@ -3795,6 +3799,18 @@ <h2 id="commands">Commands<a class="headerlink" href="#commands" title="Permanen
37953799
<td>MCP server for AI tool integration (stdin/stdout)</td>
37963800
</tr>
37973801
<tr>
3802+
<td><a href="tools/#ctx-steering"><code>ctx steering</code></a></td>
3803+
<td>Manage steering files (behavioral rules for AI tools)</td>
3804+
</tr>
3805+
<tr>
3806+
<td><a href="tools/#ctx-hook"><code>ctx hook</code></a></td>
3807+
<td>Manage lifecycle hooks (shell scripts for automation)</td>
3808+
</tr>
3809+
<tr>
3810+
<td><a href="tools/#ctx-skill"><code>ctx skill</code></a></td>
3811+
<td>Manage reusable instruction bundles</td>
3812+
</tr>
3813+
<tr>
37983814
<td><a href="config/#ctx-config"><code>ctx config</code></a></td>
37993815
<td>Manage runtime configuration profiles</td>
38003816
</tr>
@@ -3904,6 +3920,15 @@ <h2 id="configuration-file">Configuration File<a class="headerlink" href="#confi
39043920
</span><span id="__span-1-32"><a id="__codelineno-1-32" name="__codelineno-1-32" href="#__codelineno-1-32"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">nudge</span>
39053921
</span><span id="__span-1-33"><a id="__codelineno-1-33" name="__codelineno-1-33" href="#__codelineno-1-33"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">relay</span>
39063922
</span><span id="__span-1-34"><a id="__codelineno-1-34" name="__codelineno-1-34" href="#__codelineno-1-34"></a><span class="w"> </span><span class="c1"># - heartbeat # Every-prompt session-alive signal</span>
3923+
</span><span id="__span-1-35"><a id="__codelineno-1-35" name="__codelineno-1-35" href="#__codelineno-1-35"></a><span class="nt">tool</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&quot;</span><span class="w"> </span><span class="c1"># Active AI tool: claude, cursor, cline, kiro, codex</span>
3924+
</span><span id="__span-1-36"><a id="__codelineno-1-36" name="__codelineno-1-36" href="#__codelineno-1-36"></a><span class="nt">steering</span><span class="p">:</span><span class="w"> </span><span class="c1"># Steering layer configuration</span>
3925+
</span><span id="__span-1-37"><a id="__codelineno-1-37" name="__codelineno-1-37" href="#__codelineno-1-37"></a><span class="w"> </span><span class="nt">dir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.context/steering</span><span class="w"> </span><span class="c1"># Steering files directory</span>
3926+
</span><span id="__span-1-38"><a id="__codelineno-1-38" name="__codelineno-1-38" href="#__codelineno-1-38"></a><span class="w"> </span><span class="nt">default_inclusion</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">manual</span><span class="w"> </span><span class="c1"># Default inclusion mode (always, auto, manual)</span>
3927+
</span><span id="__span-1-39"><a id="__codelineno-1-39" name="__codelineno-1-39" href="#__codelineno-1-39"></a><span class="w"> </span><span class="nt">default_tools</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[]</span><span class="w"> </span><span class="c1"># Default tool filter for new steering files</span>
3928+
</span><span id="__span-1-40"><a id="__codelineno-1-40" name="__codelineno-1-40" href="#__codelineno-1-40"></a><span class="nt">hooks</span><span class="p">:</span><span class="w"> </span><span class="c1"># Hook system configuration</span>
3929+
</span><span id="__span-1-41"><a id="__codelineno-1-41" name="__codelineno-1-41" href="#__codelineno-1-41"></a><span class="w"> </span><span class="nt">dir</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.context/hooks</span><span class="w"> </span><span class="c1"># Hook scripts directory</span>
3930+
</span><span id="__span-1-42"><a id="__codelineno-1-42" name="__codelineno-1-42" href="#__codelineno-1-42"></a><span class="w"> </span><span class="nt">timeout</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">10</span><span class="w"> </span><span class="c1"># Per-hook execution timeout in seconds</span>
3931+
</span><span id="__span-1-43"><a id="__codelineno-1-43" name="__codelineno-1-43" href="#__codelineno-1-43"></a><span class="w"> </span><span class="nt">enabled</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"> </span><span class="c1"># Whether hook execution is enabled</span>
39073932
</span></code></pre></div>
39083933
<table>
39093934
<thead>
@@ -4029,6 +4054,48 @@ <h2 id="configuration-file">Configuration File<a class="headerlink" href="#confi
40294054
<td><em>(all)</em></td>
40304055
<td>Event filter for webhook notifications (empty = all)</td>
40314056
</tr>
4057+
<tr>
4058+
<td><code>tool</code></td>
4059+
<td><code>string</code></td>
4060+
<td><em>(empty)</em></td>
4061+
<td>Active AI tool identifier (<code>claude</code>, <code>cursor</code>, <code>cline</code>, <code>kiro</code>, <code>codex</code>)</td>
4062+
</tr>
4063+
<tr>
4064+
<td><code>steering.dir</code></td>
4065+
<td><code>string</code></td>
4066+
<td><code>.context/steering</code></td>
4067+
<td>Steering files directory</td>
4068+
</tr>
4069+
<tr>
4070+
<td><code>steering.default_inclusion</code></td>
4071+
<td><code>string</code></td>
4072+
<td><code>manual</code></td>
4073+
<td>Default inclusion mode for new steering files (<code>always</code>, <code>auto</code>, <code>manual</code>)</td>
4074+
</tr>
4075+
<tr>
4076+
<td><code>steering.default_tools</code></td>
4077+
<td><code>[]string</code></td>
4078+
<td><em>(all)</em></td>
4079+
<td>Default tool filter for new steering files (empty = all tools)</td>
4080+
</tr>
4081+
<tr>
4082+
<td><code>hooks.dir</code></td>
4083+
<td><code>string</code></td>
4084+
<td><code>.context/hooks</code></td>
4085+
<td>Hook scripts directory</td>
4086+
</tr>
4087+
<tr>
4088+
<td><code>hooks.timeout</code></td>
4089+
<td><code>int</code></td>
4090+
<td><code>10</code></td>
4091+
<td>Per-hook execution timeout in seconds</td>
4092+
</tr>
4093+
<tr>
4094+
<td><code>hooks.enabled</code></td>
4095+
<td><code>bool</code></td>
4096+
<td><code>true</code></td>
4097+
<td>Whether hook execution is enabled</td>
4098+
</tr>
40324099
</tbody>
40334100
</table>
40344101
<p><strong>Priority order:</strong> CLI flags &gt; Environment variables &gt; <code>.ctxrc</code> &gt; Defaults</p>

site/cli/mcp/index.html

Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3040,6 +3040,50 @@
30403040
</span>
30413041
</a>
30423042

3043+
</li>
3044+
3045+
<li class="md-nav__item">
3046+
<a href="#ctx_steering_get" class="md-nav__link">
3047+
<span class="md-ellipsis">
3048+
3049+
ctx_steering_get
3050+
3051+
</span>
3052+
</a>
3053+
3054+
</li>
3055+
3056+
<li class="md-nav__item">
3057+
<a href="#ctx_search" class="md-nav__link">
3058+
<span class="md-ellipsis">
3059+
3060+
ctx_search
3061+
3062+
</span>
3063+
</a>
3064+
3065+
</li>
3066+
3067+
<li class="md-nav__item">
3068+
<a href="#ctx_session_start" class="md-nav__link">
3069+
<span class="md-ellipsis">
3070+
3071+
ctx_session_start
3072+
3073+
</span>
3074+
</a>
3075+
3076+
</li>
3077+
3078+
<li class="md-nav__item">
3079+
<a href="#ctx_session_end" class="md-nav__link">
3080+
<span class="md-ellipsis">
3081+
3082+
ctx_session_end
3083+
3084+
</span>
3085+
</a>
3086+
30433087
</li>
30443088

30453089
<li class="md-nav__item">
@@ -4071,6 +4115,50 @@
40714115
</span>
40724116
</a>
40734117

4118+
</li>
4119+
4120+
<li class="md-nav__item">
4121+
<a href="#ctx_steering_get" class="md-nav__link">
4122+
<span class="md-ellipsis">
4123+
4124+
ctx_steering_get
4125+
4126+
</span>
4127+
</a>
4128+
4129+
</li>
4130+
4131+
<li class="md-nav__item">
4132+
<a href="#ctx_search" class="md-nav__link">
4133+
<span class="md-ellipsis">
4134+
4135+
ctx_search
4136+
4137+
</span>
4138+
</a>
4139+
4140+
</li>
4141+
4142+
<li class="md-nav__item">
4143+
<a href="#ctx_session_start" class="md-nav__link">
4144+
<span class="md-ellipsis">
4145+
4146+
ctx_session_start
4147+
4148+
</span>
4149+
</a>
4150+
4151+
</li>
4152+
4153+
<li class="md-nav__item">
4154+
<a href="#ctx_session_end" class="md-nav__link">
4155+
<span class="md-ellipsis">
4156+
4157+
ctx_session_end
4158+
4159+
</span>
4160+
</a>
4161+
40744162
</li>
40754163

40764164
<li class="md-nav__item">
@@ -4599,6 +4687,75 @@ <h3 id="ctx_session_event"><code>ctx_session_event</code><a class="headerlink" h
45994687
</tr>
46004688
</tbody>
46014689
</table>
4690+
<h3 id="ctx_steering_get"><code>ctx_steering_get</code><a class="headerlink" href="#ctx_steering_get" title="Permanent link">&para;</a></h3>
4691+
<p>Retrieve applicable steering files for a prompt. Without a prompt,
4692+
returns always-included files only.</p>
4693+
<table>
4694+
<thead>
4695+
<tr>
4696+
<th>Argument</th>
4697+
<th>Type</th>
4698+
<th>Required</th>
4699+
<th>Description</th>
4700+
</tr>
4701+
</thead>
4702+
<tbody>
4703+
<tr>
4704+
<td><code>prompt</code></td>
4705+
<td>string</td>
4706+
<td>No</td>
4707+
<td>Prompt text to match against steering file descriptions</td>
4708+
</tr>
4709+
</tbody>
4710+
</table>
4711+
<p><strong>Read-only.</strong></p>
4712+
<h3 id="ctx_search"><code>ctx_search</code><a class="headerlink" href="#ctx_search" title="Permanent link">&para;</a></h3>
4713+
<p>Search across <code>.context/</code> files for a query string. Returns matching
4714+
lines with file paths and line numbers.</p>
4715+
<table>
4716+
<thead>
4717+
<tr>
4718+
<th>Argument</th>
4719+
<th>Type</th>
4720+
<th>Required</th>
4721+
<th>Description</th>
4722+
</tr>
4723+
</thead>
4724+
<tbody>
4725+
<tr>
4726+
<td><code>query</code></td>
4727+
<td>string</td>
4728+
<td>Yes</td>
4729+
<td>Search string to match against</td>
4730+
</tr>
4731+
</tbody>
4732+
</table>
4733+
<p><strong>Read-only.</strong></p>
4734+
<h3 id="ctx_session_start"><code>ctx_session_start</code><a class="headerlink" href="#ctx_session_start" title="Permanent link">&para;</a></h3>
4735+
<p>Execute session-start hooks and return aggregated context from hook
4736+
outputs.</p>
4737+
<p><strong>Arguments:</strong> None.</p>
4738+
<h3 id="ctx_session_end"><code>ctx_session_end</code><a class="headerlink" href="#ctx_session_end" title="Permanent link">&para;</a></h3>
4739+
<p>Execute session-end hooks with an optional summary. Returns aggregated
4740+
context from hook outputs.</p>
4741+
<table>
4742+
<thead>
4743+
<tr>
4744+
<th>Argument</th>
4745+
<th>Type</th>
4746+
<th>Required</th>
4747+
<th>Description</th>
4748+
</tr>
4749+
</thead>
4750+
<tbody>
4751+
<tr>
4752+
<td><code>summary</code></td>
4753+
<td>string</td>
4754+
<td>No</td>
4755+
<td>Session summary passed to hook scripts</td>
4756+
</tr>
4757+
</tbody>
4758+
</table>
46024759
<h3 id="ctx_remind"><code>ctx_remind</code><a class="headerlink" href="#ctx_remind" title="Permanent link">&para;</a></h3>
46034760
<p>List pending session-scoped reminders.</p>
46044761
<p><strong>Arguments:</strong> None. <strong>Read-only.</strong></p>

0 commit comments

Comments
 (0)