@thallylabs/cli 0.8.14 → 0.8.16

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.
Files changed (3) hide show
  1. package/README.md +31 -20
  2. package/dist/index.js +1 -1
  3. package/package.json +3 -3
package/README.md CHANGED
@@ -5,30 +5,35 @@ One tool, one mental model. You author **content + config**; the framework
5
5
 
6
6
  ## The model
7
7
 
8
- A Thally project is just three things you own:
8
+ You own the portable content and configuration surfaces:
9
9
 
10
- - `src/content/` — your MDX pages
11
- - `docs.json` — navigation, theme, and config
10
+ - `src/content/` — MDX pages
11
+ - `docs.json` — navigation, theme, and product configuration
12
+ - `src/data/site.ts` — site identity, links, and brand defaults
13
+ - `src/mdx/custom-components.tsx` — customer MDX components
12
14
  - `snippets/` — reusable MDX
15
+ - `public/` and `openapi.yaml` — public assets and API specifications
13
16
 
14
- Everything under `src/app/` is framework plumbing managed by Thally. You should
15
- never need to edit it. The `thally` commands wrap the framework so the runtime
16
- stays invisible.
17
+ Framework-owned paths are recorded in `starter-release.json` and managed by
18
+ Thally. `src/app/` is framework plumbing, but it is not the complete ownership
19
+ contract. The `thally` commands keep the runtime invisible while preserving
20
+ customer-owned paths during upgrades.
17
21
 
18
22
  ## Commands
19
23
 
20
- | Command | What it does |
21
- | --- | --- |
22
- | `thally init [dir]` | Scaffold a new Thally project |
23
- | `thally dev` | Run the docs site locally (agent endpoints live) |
24
- | `thally build` | Build the production site |
25
- | `thally start` | Serve the built production site |
26
- | `thally deploy [--prod]` | Build and deploy to a live URL, print agent endpoints |
27
- | `thally check [--agents] [--fix]` | Lint content + Agent Readiness Score |
28
- | `thally new <page-id> [--title]` | Create a page and register it in `docs.json` |
29
- | `thally migrate <github-or-docs-url> [dir]` | Migrate a docs repository or public docs site |
30
- | `thally translate --locale <code>` | Translate content into a locale |
31
- | `thally mcp` | Start the Model Context Protocol server (stdio) |
24
+ | Command | What it does |
25
+ | ------------------------------------------- | -------------------------------------------------------------- |
26
+ | `thally init [dir]` | Scaffold a new Thally project |
27
+ | `thally dev` | Run the docs site locally (agent endpoints live) |
28
+ | `thally build` | Build the production site |
29
+ | `thally start` | Serve the built production site |
30
+ | `thally deploy [--prod]` | Build and deploy to a live URL, print agent endpoints |
31
+ | `thally check [--agents] [--fix]` | Lint content + Agent Readiness Score |
32
+ | `thally new <page-id> [--title]` | Create a page and register it in `docs.json` |
33
+ | `thally migrate <github-or-docs-url> [dir]` | Migrate a docs repository or public docs site |
34
+ | `thally translate --locale <code>` | Translate content into a locale |
35
+ | `thally starter update [--apply]` | Plan or explicitly apply an immutable three-way runtime update |
36
+ | `thally mcp` | Start the Model Context Protocol server (stdio) |
32
37
 
33
38
  `thally migrate` asks which platform currently hosts the docs and dispatches to
34
39
  the Mintlify or Docusaurus adapter. Non-interactive callers can pass
@@ -36,13 +41,19 @@ the Mintlify or Docusaurus adapter. Non-interactive callers can pass
36
41
 
37
42
  Run `thally` with no arguments for the full help.
38
43
 
44
+ `thally starter update` is a dry run by default. It compares the previously
45
+ recorded scaffold, the promoted target scaffold, and the current project. It
46
+ automatically updates unchanged framework-owned files, preserves user-owned
47
+ paths, and reports manual-review conflicts before `--apply` writes anything.
48
+
39
49
  ## How it works
40
50
 
41
51
  - **Framework commands** (`dev`, `build`, `start`, `deploy`) prefer the
42
52
  project's npm scripts and fall back to invoking the framework directly — so
43
53
  the framework is an implementation detail, not part of your surface.
44
54
  - **Authoring commands** (`init`, `migrate`, `translate`) delegate to
45
- `create-thally-docs`; `mcp` starts `@thallylabs/mcp`. All capabilities are reachable through
46
- the single `thally` binary.
55
+ `create-thally-docs`; `starter update` uses the same immutable scaffold
56
+ catalog and ownership-aware updater; `mcp` starts `@thallylabs/mcp`. All
57
+ capabilities are reachable through the single `thally` binary.
47
58
  - **`check --agents`** runs content lint plus the Agent Readiness Score, with a
48
59
  CI-friendly non-zero exit code when the score is below the threshold.
package/dist/index.js CHANGED
@@ -53,7 +53,7 @@ function helpText() {
53
53
  lines.push(" thally \u2014 keep customer-facing knowledge in sync with product changes");
54
54
  lines.push("");
55
55
  lines.push(" Connect product evidence, prepare reviewable updates, and publish one trusted source.");
56
- lines.push(" You author content/, docs.json, and snippets/.");
56
+ lines.push(" You author src/content/, docs.json, site.ts, custom MDX, snippets/, and public assets.");
57
57
  lines.push(" The framework (Next.js) is a hidden runtime \u2014 you never touch src/app/.");
58
58
  lines.push("");
59
59
  lines.push(" Usage: thally <command> [options]");
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@thallylabs/cli",
3
- "version": "0.8.14",
3
+ "version": "0.8.16",
4
4
  "description": "The Thally CLI for authoring knowledge surfaces, tracing product changes, and keeping documentation checked.",
5
5
  "type": "module",
6
6
  "engines": {
@@ -24,8 +24,8 @@
24
24
  },
25
25
  "dependencies": {
26
26
  "@anthropic-ai/sdk": "^0.78.0",
27
- "@thallylabs/mcp": "0.10.14",
28
- "create-thally-docs": "0.10.13"
27
+ "@thallylabs/mcp": "0.10.16",
28
+ "create-thally-docs": "0.10.15"
29
29
  },
30
30
  "devDependencies": {
31
31
  "@thallylabs/agent": "*",