@compaction/cli 0.1.0 → 0.1.1
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 +39 -26
- package/dist/cli/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -108,47 +108,59 @@ command that reaches the network is the explicitly operator-invoked
|
|
|
108
108
|
`capture provider-usage`, and only when the operator supplies a credential via
|
|
109
109
|
an environment variable. There is no telemetry.
|
|
110
110
|
|
|
111
|
-
###
|
|
111
|
+
### npm / npx — LIVE NOW (`@compaction/cli@0.1.1` is published)
|
|
112
112
|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
below are the intended public install path and will work **only at launch**, once
|
|
116
|
-
the package is published **and** the script is hosted. Do not expect them to work
|
|
117
|
-
today.
|
|
113
|
+
**`@compaction/cli` is published to npm and installs today.** Install it globally,
|
|
114
|
+
or run it with no global install via `npx`:
|
|
118
115
|
|
|
119
116
|
```bash
|
|
120
|
-
#
|
|
121
|
-
# One-line installer (hosted at cli.compaction.dev at launch):
|
|
122
|
-
curl -fsSL https://cli.compaction.dev/install | sh
|
|
123
|
-
# Inspect it first (recommended): pipe to `less`, or download and read, before sh.
|
|
124
|
-
curl -fsSL https://cli.compaction.dev/install | less
|
|
125
|
-
|
|
126
|
-
# or with npm / npx, once published:
|
|
117
|
+
# Published and live now (v0.1.1):
|
|
127
118
|
npm install -g @compaction/cli # then: compaction init
|
|
128
119
|
npx @compaction/cli init # no global install
|
|
120
|
+
npx @compaction/cli --help # no install at all
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
The installed binary is `compaction`. After a global install, sanity-check with
|
|
124
|
+
`compaction --version` (→ `0.1.1`) and `compaction --help`.
|
|
125
|
+
|
|
126
|
+
### curl one-liner (`cli.compaction.dev`) — LIVE NOW
|
|
127
|
+
|
|
128
|
+
**The hosted curl install path is live** at `https://cli.compaction.dev/install`
|
|
129
|
+
(HTTPS, valid TLS). The installer is served as `text/plain` (no caching) and its only
|
|
130
|
+
network call is the `npm install` of the published package. Read it first, then run it:
|
|
131
|
+
|
|
132
|
+
```bash
|
|
133
|
+
# LIVE NOW.
|
|
134
|
+
# Inspect it first (recommended): pipe to `less`, or download and read, before sh.
|
|
135
|
+
curl -fsSL https://cli.compaction.dev/install | less
|
|
136
|
+
# One-line installer:
|
|
137
|
+
curl -fsSL https://cli.compaction.dev/install | sh
|
|
129
138
|
```
|
|
130
139
|
|
|
131
140
|
The installer ([`scripts/install.sh`](scripts/install.sh)) is checked into the repo
|
|
132
141
|
and readable now: it uses **no `sudo` by default** (installs into a user-writable
|
|
133
|
-
prefix), makes **no network call except the npm install**
|
|
134
|
-
macOS + Linux, and **fails clearly
|
|
135
|
-
|
|
142
|
+
prefix), makes **no network call except the npm install** of the published package
|
|
143
|
+
(no telemetry), supports macOS + Linux, and **fails clearly** rather than faking
|
|
144
|
+
success. Preview exactly what it would do without installing anything:
|
|
136
145
|
|
|
137
146
|
```bash
|
|
138
147
|
sh scripts/install.sh --dry-run
|
|
139
148
|
```
|
|
140
149
|
|
|
141
150
|
See [`docs/ops/install-readiness.md`](docs/ops/install-readiness.md) for the full
|
|
142
|
-
install-readiness contract (hosting, package name, version pinning, platforms
|
|
143
|
-
|
|
151
|
+
install-readiness contract (hosting, package name, version pinning, platforms) and
|
|
152
|
+
[`docs/ops/cli-install-domain-readiness.md`](docs/ops/cli-install-domain-readiness.md)
|
|
153
|
+
for the curl-route deploy/DNS execution record.
|
|
144
154
|
|
|
145
155
|
This repository is licensed under **AGPL-3.0-only** (see [`LICENSE`](LICENSE)). The
|
|
146
156
|
npm **package name is `@compaction/cli`** (scoped, public; the installed binary
|
|
147
|
-
stays `compaction`)
|
|
148
|
-
|
|
149
|
-
|
|
157
|
+
stays `compaction`) and it is **published and live now** (v0.1.1). The **npm/npx and
|
|
158
|
+
curl install paths are all live.**
|
|
159
|
+
|
|
160
|
+
### From source — for contributors / local development
|
|
150
161
|
|
|
151
|
-
|
|
162
|
+
(For just running the tool, the **npm / npx** path above is now the simplest. Build
|
|
163
|
+
from source when you want to hack on the CLI itself.)
|
|
152
164
|
|
|
153
165
|
```bash
|
|
154
166
|
git clone <repo-url>
|
|
@@ -161,14 +173,15 @@ npm link
|
|
|
161
173
|
|
|
162
174
|
For reproducible local validation, use `npm ci` (not `npm install`).
|
|
163
175
|
|
|
164
|
-
### Local tarball install (
|
|
176
|
+
### Local tarball install (offline / air-gapped fallback)
|
|
165
177
|
|
|
166
|
-
|
|
167
|
-
|
|
178
|
+
The package is on npm now (use the npm / npx path above for the normal case). This
|
|
179
|
+
packed-tarball path remains useful for an offline / air-gapped install or to verify
|
|
180
|
+
the exact published layout locally — a **fallback**, not the intended public path:
|
|
168
181
|
|
|
169
182
|
```bash
|
|
170
183
|
npm pack
|
|
171
|
-
npm install -g ./compaction-cli-0.1.
|
|
184
|
+
npm install -g ./compaction-cli-0.1.1.tgz
|
|
172
185
|
```
|
|
173
186
|
|
|
174
187
|
The package layout is verified by `npm run smoke:package`, which packs the
|
package/dist/cli/index.js
CHANGED
|
@@ -27,7 +27,7 @@ const program = new Command();
|
|
|
27
27
|
program
|
|
28
28
|
.name("compaction")
|
|
29
29
|
.description("CLI-first trace compaction tools for AI agent workflows.")
|
|
30
|
-
.version("0.1.
|
|
30
|
+
.version("0.1.1");
|
|
31
31
|
registerAnalyzeCommand(program);
|
|
32
32
|
registerAdapterCommand(program);
|
|
33
33
|
registerAggregateCommand(program);
|