@kontourai/station-cli 0.6.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 +201 -0
- package/README.md +273 -0
- package/dist/station.mjs +1163 -0
- package/package.json +52 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,273 @@
|
|
|
1
|
+
# @kontourai/station-cli
|
|
2
|
+
|
|
3
|
+
Station is Kontour's local-first agent workspace: you direct agent work, and
|
|
4
|
+
the gate verdicts, evidence, and trust state stay in the same context as the
|
|
5
|
+
work. A Station is the process that holds all of that — on your laptop, a home
|
|
6
|
+
server, or another machine on your tailnet.
|
|
7
|
+
|
|
8
|
+
This package is the **client** CLI for those Stations. It is a terminal front end
|
|
9
|
+
for Stations that are already running: chat with agents, read and interrupt
|
|
10
|
+
sessions, drive projects, tasks, skills, and every other Station
|
|
11
|
+
surface, over HTTP. It does not run a Station itself — see
|
|
12
|
+
[What this CLI does not do](#what-this-cli-does-not-do).
|
|
13
|
+
|
|
14
|
+
## Availability
|
|
15
|
+
|
|
16
|
+
The `npx`/`npm install -g` forms below work once `@kontourai/station-cli` is
|
|
17
|
+
live on the npm registry (station#4536; check with `npm view
|
|
18
|
+
@kontourai/station-cli`) — until then they 404, and `./station` from a
|
|
19
|
+
Station checkout, further down this section, is the way to run the CLI.
|
|
20
|
+
|
|
21
|
+
Run the CLI with `npx`, pinned to the channel dist-tag matching the Station
|
|
22
|
+
you are operating — `nightly` for a Station Nightly host, `latest` for a
|
|
23
|
+
stable one:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
npx @kontourai/station-cli@latest --help
|
|
27
|
+
npx @kontourai/station-cli@nightly --help
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
`npx` resolves and caches that exact published version per invocation, so the
|
|
31
|
+
channel tag is the whole story: no separate install/upgrade step, and no
|
|
32
|
+
ambiguity about which build is running. For latency-sensitive or scripted use,
|
|
33
|
+
an explicit global install pins one version instead of resolving on every
|
|
34
|
+
call: `npm install -g @kontourai/station-cli@<tag>`.
|
|
35
|
+
|
|
36
|
+
**Inside a Station checkout**, `./station` runs that tree's own build directly
|
|
37
|
+
— this is the local-invocation path when the registry isn't the point (working
|
|
38
|
+
on the CLI itself, or a channel tag you don't want to depend on):
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
./station <command> [args]
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
It refuses to run against a stale build rather than silently executing old
|
|
45
|
+
code — see [the CLI reference](https://github.com/kontourai/station/blob/main/docs/reference/cli.md#invocation)
|
|
46
|
+
for the freshness gate and the three-tier invocation story (`npx` / `./station`
|
|
47
|
+
/ the `station-dev` global dev shim).
|
|
48
|
+
|
|
49
|
+
Every invocation reports where it came from: `station --version` prints the
|
|
50
|
+
CLI version, its build channel, and the source revision the artifact was built
|
|
51
|
+
from, so a wrong-binary mistake is visible instead of guessed at.
|
|
52
|
+
|
|
53
|
+
## Sixty seconds to a working setup
|
|
54
|
+
|
|
55
|
+
Choose a Station you can reach. Setup saves it on this device, performs pairing
|
|
56
|
+
when needed, and deliberately selects the default Station.
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
npx @kontourai/station-cli@latest setup existing box-b https://box-b.tailnet.ts.net --pair
|
|
60
|
+
# or use Kontour's hosted Station
|
|
61
|
+
npx @kontourai/station-cli@latest setup hosted
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
The CLI registers a device request and waits. An operator approves it **on the
|
|
65
|
+
host** (`station environment access approve <request-id>` there). When they do,
|
|
66
|
+
the CLI stores the issued bearer credential in the operating-system keyring and
|
|
67
|
+
saves only its reference with the Station entry. That Station becomes the
|
|
68
|
+
default only after pairing succeeds.
|
|
69
|
+
|
|
70
|
+
That is the whole point of pairing: from then on, nothing needs a flag.
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
station agents list
|
|
74
|
+
station chat my-agent 'what changed today?'
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
From a Station checkout, local setup installs its durable per-user service and
|
|
78
|
+
then selects the conventional `kontour` Station:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
./station setup local
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Saved Stations
|
|
85
|
+
|
|
86
|
+
These are the Stations this device can reach. Forgetting one only removes its
|
|
87
|
+
local entry and credential reference; it does not stop or delete the Station.
|
|
88
|
+
They are separate from the Environment where an Agent executes and the engine
|
|
89
|
+
that runs it.
|
|
90
|
+
|
|
91
|
+
```text
|
|
92
|
+
station stations list
|
|
93
|
+
station stations show <name>
|
|
94
|
+
station stations add <name> <endpoint> [--pair] [--default] [--force]
|
|
95
|
+
station stations edit <name> <endpoint> [--pair] [--default] [--force]
|
|
96
|
+
station stations pair <name> [--force]
|
|
97
|
+
station stations use <name>
|
|
98
|
+
station stations forget <name>
|
|
99
|
+
station stations project show|use <name>|clear
|
|
100
|
+
station stations export
|
|
101
|
+
station target [--station=<name>|--api-base=<url>]
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
```console
|
|
105
|
+
$ station stations list
|
|
106
|
+
NAME ENDPOINT CREDENTIAL
|
|
107
|
+
* box-b https://box-b.tailnet.ts.net available
|
|
108
|
+
kontour http://127.0.0.1:<channel-port> not-configured
|
|
109
|
+
|
|
110
|
+
* = default Station.
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Every command that talks to a Station resolves its target in this order:
|
|
114
|
+
|
|
115
|
+
| | Source | Example |
|
|
116
|
+
|---|---|---|
|
|
117
|
+
| 1 | `--api-base=<origin>` | one direct bootstrap/diagnostic request |
|
|
118
|
+
| 2 | `--station=<name>` | `station chat --station=box-b` |
|
|
119
|
+
| 3 | `STATION_TARGET` | `STATION_TARGET=kontour station agents list` |
|
|
120
|
+
| 4 | Project Station selection | owner-controlled mapping set by `station stations project use` |
|
|
121
|
+
| 5 | Explicit default Station | set by setup or `station stations use` |
|
|
122
|
+
| 6 | Active local Station | owner-safe local service record |
|
|
123
|
+
| 7 | Loopback fallback | the selected channel's runtime-resolver server port (or `STATION_PORT`) |
|
|
124
|
+
|
|
125
|
+
## Guided triage
|
|
126
|
+
|
|
127
|
+
`station triage [--context-only] [--agent=codex|claude] [--problem=<text>] [--search-issues]` writes a bounded,
|
|
128
|
+
owner-only diagnostic hand-off under `$STATION_ROOT/cache/triage/<uuid>`.
|
|
129
|
+
It contains redacted schema-v1 JSON, a readable summary, and Station's
|
|
130
|
+
versioned read-only playbook. With an existing credential it uses the
|
|
131
|
+
authenticated diagnostics-bundle seam, retaining only bounded allowlisted app,
|
|
132
|
+
doctor, and log-tail facts; it never persists bearer values or bundle config.
|
|
133
|
+
It never reads local-grant or pairing secrets, databases, arbitrary environment
|
|
134
|
+
data, or full logs.
|
|
135
|
+
|
|
136
|
+
Use `--context-only` when you want artifacts without agent probing or launch;
|
|
137
|
+
the same read-only source and authenticated remote facts are still collected.
|
|
138
|
+
Otherwise Station starts only Codex with approval disabled, its read-only
|
|
139
|
+
sandbox, an ephemeral session, and user config ignored, or Claude in safe plan
|
|
140
|
+
mode with only Read/Glob/Grep tools, using argv arrays and a run-local prompt
|
|
141
|
+
file. With both available,
|
|
142
|
+
select one explicitly. No available agent still
|
|
143
|
+
leaves portable artifacts successfully. The bundled CLI does not inspect the
|
|
144
|
+
local host filesystem or run the source-only doctor report.
|
|
145
|
+
Problem text stays local unless `--search-issues` (or the equivalent TTY
|
|
146
|
+
confirmation) explicitly authorizes a fixed, read-only Station issue search.
|
|
147
|
+
Successful agent output is bounded and re-redacted into local `diagnosis.md`
|
|
148
|
+
and `issue-draft.md`; triage has no GitHub write or repair operation.
|
|
149
|
+
|
|
150
|
+
The versioned store lives at `$STATION_ROOT/config/profiles.json` (default
|
|
151
|
+
`~/.station/config/profiles.json`) and is shared with native Desktop. It
|
|
152
|
+
never contains bearer material. A missing or unavailable OS credential store
|
|
153
|
+
fails closed; Station does not create a plaintext fallback. `station target`
|
|
154
|
+
shows the selected Station, endpoint, Environment association, credential
|
|
155
|
+
state, reachability, and applicable local-service state without starting or
|
|
156
|
+
substituting another Station.
|
|
157
|
+
|
|
158
|
+
Use `--pair` while adding or editing, or `station stations pair <name>`, to
|
|
159
|
+
authenticate a named Station through host approval. Plain add/edit intentionally
|
|
160
|
+
creates or updates only endpoint metadata and reports that no credential is
|
|
161
|
+
configured. Pairing does not replace an existing endpoint binding unless the
|
|
162
|
+
edit action or `--force` explicitly authorizes it.
|
|
163
|
+
|
|
164
|
+
Project selection is explicit and secret-free. `station stations project use`
|
|
165
|
+
records the canonical invoked directory and selected Station in the
|
|
166
|
+
owner-controlled shared store; repository files cannot redirect the target.
|
|
167
|
+
The selection names a saved Station and never embeds an endpoint or credential.
|
|
168
|
+
|
|
169
|
+
Requests give up after 30 seconds. Override with
|
|
170
|
+
`STATION_REQUEST_TIMEOUT_MS=<ms>`, or `0` to disable the deadline. Streams —
|
|
171
|
+
chat and session turns, orchestration and approval event streams, live
|
|
172
|
+
monitoring, knowledge reindexing — are deliberately exempt, because they are
|
|
173
|
+
open-ended by design.
|
|
174
|
+
|
|
175
|
+
## What this CLI does not do
|
|
176
|
+
|
|
177
|
+
**It does not run a Station.** These verbs act on a Station *repository
|
|
178
|
+
checkout* — building the app, starting or upgrading it, installing OS
|
|
179
|
+
services, putting the launcher on PATH:
|
|
180
|
+
|
|
181
|
+
`build` · `doctor` · `fresh` · `link` · `service` · `shortcut` · `start` ·
|
|
182
|
+
`upgrade`
|
|
183
|
+
|
|
184
|
+
They are not part of the published CLI. Run them from the root of a Station
|
|
185
|
+
checkout with its own launcher, which is where they have always lived:
|
|
186
|
+
|
|
187
|
+
```console
|
|
188
|
+
$ station start
|
|
189
|
+
Error: `station start` runs against a Station repository checkout, so it is not part of the published CLI.
|
|
190
|
+
Run it from the root of a Station checkout with the bundled launcher:
|
|
191
|
+
./station start
|
|
192
|
+
The published CLI drives Stations that are already running — see `station stations`, `station setup hosted`, and `--api-base`.
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
**Some `environment` verbs are host-local.** Identity, credential, and
|
|
196
|
+
device-approval commands read secrets that only exist on the machine running
|
|
197
|
+
the Station, so they answer from the host's own `./station` and nowhere else:
|
|
198
|
+
`environment show`, `environment credential`, `environment reset`, and
|
|
199
|
+
`environment offer`, and `environment access list|approve|deny`.
|
|
200
|
+
|
|
201
|
+
```console
|
|
202
|
+
$ station environment show
|
|
203
|
+
Error: Environment security commands require the Station repository launcher (./station).
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
`station environment access request` is the exception, and the one you want
|
|
207
|
+
here: it is the *requester* side of pairing, and it is a pure client.
|
|
208
|
+
|
|
209
|
+
The packaged CLI never starts, stops, builds, installs, or otherwise manages a
|
|
210
|
+
Station backend implicitly. A bare invocation (including `--inline`,
|
|
211
|
+
`--service`, and `--temp-home`) explains how to pair with an existing host or
|
|
212
|
+
how to use `./station` from a checkout. Host-side pairing offers and approvals
|
|
213
|
+
remain in that host's UI/checkout; the packaged client only requests access.
|
|
214
|
+
|
|
215
|
+
`station --version` reports immutable bundle metadata: the CLI version, its
|
|
216
|
+
build channel, and the source revision stamped when that artifact was built.
|
|
217
|
+
It does not inspect a nearby checkout or a backend build manifest. Local source
|
|
218
|
+
builds report the `development` channel (and a dirty revision when applicable),
|
|
219
|
+
independent of `STATION_CHANNEL`.
|
|
220
|
+
|
|
221
|
+
The package test packs one exact tarball, records its SHA-256, then installs
|
|
222
|
+
that same tarball into an isolated consumer with `npm install --ignore-scripts`.
|
|
223
|
+
This proves dependency resolution without claiming publication or
|
|
224
|
+
native-keyring behavior. Windows and physical native-keyring verification are
|
|
225
|
+
**NOT_VERIFIED** until exercised on those platforms.
|
|
226
|
+
|
|
227
|
+
`station --help` prints the same boundary in its closing note, so the printed
|
|
228
|
+
command list never claims a verb this CLI cannot run.
|
|
229
|
+
|
|
230
|
+
## Requirements
|
|
231
|
+
|
|
232
|
+
- **Node 24** (`engines: 24.x`). The CLI is a bundle, not a binary; it needs a
|
|
233
|
+
host Node.
|
|
234
|
+
- **A reachable Station.** Everything this CLI does, apart from managing
|
|
235
|
+
its own saved Stations and config, is an HTTP call to a Station server. With no
|
|
236
|
+
Station saved, commands use a running local desktop Station when available,
|
|
237
|
+
then fall back to the selected channel's runtime-resolver loopback origin.
|
|
238
|
+
|
|
239
|
+
Transport failures name the Station that was targeted *and where that address
|
|
240
|
+
came from*, so a wrong-target mistake never looks like a broken Station:
|
|
241
|
+
|
|
242
|
+
```console
|
|
243
|
+
$ station agents list
|
|
244
|
+
Error: Can't resolve the host in https://box-b.tailnet.ts.net (default Station "box-b"). Check the address or inspect it with `station target --station=box-b`.
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
## Getting the full reference
|
|
248
|
+
|
|
249
|
+
```bash
|
|
250
|
+
station --help # grouped, one line per command
|
|
251
|
+
station <command> --help # actions and flags for one command
|
|
252
|
+
station --version
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
`--help` is recognised at any depth, and per-command help carries the flag
|
|
256
|
+
detail. Unknown input is always a failure, never a help request: the CLI exits
|
|
257
|
+
non-zero and names the nearest real command or action.
|
|
258
|
+
|
|
259
|
+
The full prose reference — every verb, every flag, and the complete tier
|
|
260
|
+
table — ships with the Station repository as `docs/reference/cli.md`.
|
|
261
|
+
|
|
262
|
+
## Related packages
|
|
263
|
+
|
|
264
|
+
- [`@kontourai/station-sdk`](https://www.npmjs.com/package/@kontourai/station-sdk)
|
|
265
|
+
— build a Station plugin: UI components, hooks, and typed host API access.
|
|
266
|
+
- [`@kontourai/station-shared`](https://www.npmjs.com/package/@kontourai/station-shared)
|
|
267
|
+
— `buildPlugin`, manifest parsing, and the other runtime helpers.
|
|
268
|
+
- [`@kontourai/station-contracts`](https://www.npmjs.com/package/@kontourai/station-contracts)
|
|
269
|
+
— the TypeScript contracts those packages are typed against.
|
|
270
|
+
|
|
271
|
+
## License
|
|
272
|
+
|
|
273
|
+
Apache-2.0, the same licence as the rest of the `@kontourai/station-*` family.
|