@kitsy/cnos-docs 1.9.2 → 1.10.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.
Files changed (4) hide show
  1. package/docs/cli/doctor.mdx +18 -16
  2. package/docs/cli/spec.mdx +75 -0
  3. package/manifest.yml +149 -147
  4. package/package.json +1 -1
package/docs/cli/doctor.mdx CHANGED
@@ -1,16 +1,18 @@
1
- ---
2
- title: cnos doctor
3
- description: Run diagnostics across workspaces, exports, and security rules.
4
- ---
5
-
6
- # cnos doctor
7
-
8
- ```bash
9
- cnos doctor
10
- cnos doctor --json
11
- cnos doctor --fix-secret-env-mappings
12
- ```
13
-
14
- The security diagnostics now flag explicit `secret.*` env mappings as a risk because they enable plaintext secret emission into private env surfaces.
15
-
16
- If those mappings were added by mistake, `cnos doctor --fix-secret-env-mappings` removes them from `envMapping.explicit` in one shot and then reruns diagnostics.
1
+ ---
2
+ title: cnos doctor
3
+ description: Run diagnostics across workspaces, exports, and security rules.
4
+ ---
5
+
6
+ # cnos doctor
7
+
8
+ ```bash
9
+ cnos doctor
10
+ cnos doctor --json
11
+ cnos doctor --fix-secret-env-mappings
12
+ ```
13
+
14
+ The security diagnostics now flag explicit `secret.*` env mappings as a risk because they enable plaintext secret emission into private env surfaces.
15
+
16
+ If those mappings were added by mistake, `cnos doctor --fix-secret-env-mappings` removes them from `envMapping.explicit` in one shot and then reruns diagnostics.
17
+
18
+ When manifest `schema:` entries exist, `cnos doctor` also points to `cnos spec doctor` for spec-vs-config coverage and guided remediation.
package/docs/cli/spec.mdx ADDED
@@ -0,0 +1,75 @@
1
+ ---
2
+ title: cnos spec
3
+ description: Author and inspect CNOS config specs stored under schema.
4
+ ---
5
+
6
+ # cnos spec
7
+
8
+ `cnos spec` manages manifest-global config specification entries stored under `schema:` in `.cnos/cnos.yml`.
9
+
10
+ Use `cnos define`, `cnos value set`, and `cnos secret set` for concrete config values and secret refs.
11
+
12
+ ## Commands
13
+
14
+ ```bash
15
+ cnos spec list
16
+ cnos spec show value.server.port
17
+ cnos spec set value.server.port --type number --required --summary "HTTP server port"
18
+ cnos spec delete value.legacy.flag
19
+ cnos spec doctor
20
+ ```
21
+
22
+ ## list
23
+
24
+ ```bash
25
+ cnos spec list
26
+ cnos spec list --prefix value.server.
27
+ ```
28
+
29
+ ## show
30
+
31
+ ```bash
32
+ cnos spec show value.server.port
33
+ cnos spec show value.server.port --json
34
+ ```
35
+
36
+ ## set
37
+
38
+ `cnos spec set` supports two modes:
39
+
40
+ - Non-interactive: pass one or more field flags.
41
+ - Interactive: no field flags in a TTY.
42
+
43
+ Examples:
44
+
45
+ ```bash
46
+ cnos spec set value.server.port --type number --required --summary "HTTP server port"
47
+ cnos spec set value.app.stage --enum '["local","stage","prod"]'
48
+ cnos spec set value.legacy.flag --clear-deprecated
49
+ ```
50
+
51
+ Field flags use JSON-first parsing for `--default`, `--example`, and `--enum`.
52
+
53
+ For `secret.*` keys, `--default`, `--example`, and `--enum` are rejected to avoid plaintext secret material in the manifest.
54
+
55
+ ## delete
56
+
57
+ ```bash
58
+ cnos spec delete value.legacy.flag
59
+ cnos spec remove value.legacy.flag --json
60
+ ```
61
+
62
+ ## doctor
63
+
64
+ ```bash
65
+ cnos spec doctor
66
+ cnos spec doctor --json
67
+ cnos spec doctor --fill-missing
68
+ cnos spec doctor --review-all
69
+ ```
70
+
71
+ `--fill-missing` and `--review-all` are interactive write modes. In Phases 1-3 they:
72
+
73
+ - require a TTY,
74
+ - require a writable local root (remote roots are read-only),
75
+ - reject `--json`.
package/manifest.yml CHANGED
@@ -1,147 +1,149 @@
1
- product: cnos
2
- title: CNOS Documentation
3
- tagline: Configuration orchestration for apps, monorepos, and deployment pipelines
4
- version: "1.9.2"
5
-
6
- sidebar:
7
- - group: Getting Started
8
- items:
9
- - path: getting-started/index
10
- label: Overview
11
- - path: getting-started/installation
12
- label: Installation
13
- - path: getting-started/quick-start
14
- label: Quick Start
15
- - path: getting-started/your-first-project
16
- label: Your First Project
17
-
18
- - group: Guides
19
- items:
20
- - path: guides/backend
21
- label: Backend Projects
22
- - path: guides/frontend-vite
23
- label: Frontend with Vite
24
- - path: guides/frontend-webpack
25
- label: Frontend with Webpack
26
- - path: guides/frontend-next
27
- label: Frontend with Next.js
28
- - path: guides/ssr
29
- label: SSR Projects
30
- - path: guides/ci-cd
31
- label: CI/CD Pipelines
32
- - path: guides/containers-and-actions
33
- label: Containers and Actions
34
- - path: guides/workspaces
35
- label: Workspaces and Monorepos
36
- - path: guides/remote-roots
37
- label: Remote Roots
38
- - path: guides/profiles
39
- label: Profiles and Environments
40
- - path: guides/derived-values
41
- label: Derived Values
42
- - path: guides/secrets
43
- label: Secrets and Vaults
44
- - path: guides/migration
45
- label: Migrating from .env
46
- - path: guides/generated-env-files
47
- label: Generated Env Files
48
-
49
- - group: CLI Reference
50
- collapsed: true
51
- items:
52
- - path: cli/index
53
- label: Overview
54
- - path: cli/init
55
- label: cnos init
56
- - path: cli/onboard
57
- label: cnos onboard
58
- - path: cli/use
59
- label: cnos use
60
- - path: cli/profile
61
- label: cnos profile
62
- - path: cli/workspace
63
- label: cnos workspace
64
- - path: cli/value
65
- label: cnos value
66
- - path: cli/secret
67
- label: cnos secret
68
- - path: cli/define
69
- label: cnos define
70
- - path: cli/list
71
- label: cnos list
72
- - path: cli/read
73
- label: cnos read
74
- - path: cli/inspect
75
- label: cnos inspect
76
- - path: cli/validate
77
- label: cnos validate
78
- - path: cli/export
79
- label: cnos export
80
- - path: cli/build
81
- label: cnos build env
82
- - path: cli/cache
83
- label: cnos cache
84
- - path: cli/dev
85
- label: cnos dev env
86
- - path: cli/run
87
- label: cnos run
88
- - path: cli/diff
89
- label: cnos diff
90
- - path: cli/dump
91
- label: cnos dump
92
- - path: cli/doctor
93
- label: cnos doctor
94
- - path: cli/ui
95
- label: cnos ui
96
- - path: cli/promote
97
- label: cnos promote
98
- - path: cli/vault
99
- label: cnos vault
100
- - path: cli/codegen
101
- label: cnos codegen
102
- - path: cli/watch
103
- label: cnos watch
104
- - path: cli/migrate
105
- label: cnos migrate
106
- - path: cli/drift
107
- label: cnos drift
108
- - path: cli/help
109
- label: cnos help
110
- - path: cli/help-ai
111
- label: cnos help-ai
112
- - path: cli/version
113
- label: cnos version
114
-
115
- - group: API Reference
116
- collapsed: true
117
- items:
118
- - path: api/index
119
- label: Overview
120
- - path: api/create-cnos
121
- label: createCnos()
122
- - path: api/runtime
123
- label: Singleton Runtime
124
- - path: api/browser
125
- label: Browser Runtime
126
- - path: api/types
127
- label: Types
128
-
129
- - group: Reference
130
- collapsed: true
131
- items:
132
- - path: reference/manifest
133
- label: Manifest
134
- - path: reference/namespaces
135
- label: Namespaces
136
- - path: reference/resolution
137
- label: Resolution
138
- - path: reference/security
139
- label: Security
140
-
141
- - group: Concepts
142
- collapsed: true
143
- items:
144
- - path: concepts/how-it-works
145
- label: How CNOS Works
146
- - path: concepts/config-spectrum
147
- label: The Config Spectrum
1
+ product: cnos
2
+ title: CNOS Documentation
3
+ tagline: Configuration orchestration for apps, monorepos, and deployment pipelines
4
+ version: "1.9.2"
5
+
6
+ sidebar:
7
+ - group: Getting Started
8
+ items:
9
+ - path: getting-started/index
10
+ label: Overview
11
+ - path: getting-started/installation
12
+ label: Installation
13
+ - path: getting-started/quick-start
14
+ label: Quick Start
15
+ - path: getting-started/your-first-project
16
+ label: Your First Project
17
+
18
+ - group: Guides
19
+ items:
20
+ - path: guides/backend
21
+ label: Backend Projects
22
+ - path: guides/frontend-vite
23
+ label: Frontend with Vite
24
+ - path: guides/frontend-webpack
25
+ label: Frontend with Webpack
26
+ - path: guides/frontend-next
27
+ label: Frontend with Next.js
28
+ - path: guides/ssr
29
+ label: SSR Projects
30
+ - path: guides/ci-cd
31
+ label: CI/CD Pipelines
32
+ - path: guides/containers-and-actions
33
+ label: Containers and Actions
34
+ - path: guides/workspaces
35
+ label: Workspaces and Monorepos
36
+ - path: guides/remote-roots
37
+ label: Remote Roots
38
+ - path: guides/profiles
39
+ label: Profiles and Environments
40
+ - path: guides/derived-values
41
+ label: Derived Values
42
+ - path: guides/secrets
43
+ label: Secrets and Vaults
44
+ - path: guides/migration
45
+ label: Migrating from .env
46
+ - path: guides/generated-env-files
47
+ label: Generated Env Files
48
+
49
+ - group: CLI Reference
50
+ collapsed: true
51
+ items:
52
+ - path: cli/index
53
+ label: Overview
54
+ - path: cli/init
55
+ label: cnos init
56
+ - path: cli/onboard
57
+ label: cnos onboard
58
+ - path: cli/use
59
+ label: cnos use
60
+ - path: cli/profile
61
+ label: cnos profile
62
+ - path: cli/workspace
63
+ label: cnos workspace
64
+ - path: cli/value
65
+ label: cnos value
66
+ - path: cli/secret
67
+ label: cnos secret
68
+ - path: cli/define
69
+ label: cnos define
70
+ - path: cli/spec
71
+ label: cnos spec
72
+ - path: cli/list
73
+ label: cnos list
74
+ - path: cli/read
75
+ label: cnos read
76
+ - path: cli/inspect
77
+ label: cnos inspect
78
+ - path: cli/validate
79
+ label: cnos validate
80
+ - path: cli/export
81
+ label: cnos export
82
+ - path: cli/build
83
+ label: cnos build env
84
+ - path: cli/cache
85
+ label: cnos cache
86
+ - path: cli/dev
87
+ label: cnos dev env
88
+ - path: cli/run
89
+ label: cnos run
90
+ - path: cli/diff
91
+ label: cnos diff
92
+ - path: cli/dump
93
+ label: cnos dump
94
+ - path: cli/doctor
95
+ label: cnos doctor
96
+ - path: cli/ui
97
+ label: cnos ui
98
+ - path: cli/promote
99
+ label: cnos promote
100
+ - path: cli/vault
101
+ label: cnos vault
102
+ - path: cli/codegen
103
+ label: cnos codegen
104
+ - path: cli/watch
105
+ label: cnos watch
106
+ - path: cli/migrate
107
+ label: cnos migrate
108
+ - path: cli/drift
109
+ label: cnos drift
110
+ - path: cli/help
111
+ label: cnos help
112
+ - path: cli/help-ai
113
+ label: cnos help-ai
114
+ - path: cli/version
115
+ label: cnos version
116
+
117
+ - group: API Reference
118
+ collapsed: true
119
+ items:
120
+ - path: api/index
121
+ label: Overview
122
+ - path: api/create-cnos
123
+ label: createCnos()
124
+ - path: api/runtime
125
+ label: Singleton Runtime
126
+ - path: api/browser
127
+ label: Browser Runtime
128
+ - path: api/types
129
+ label: Types
130
+
131
+ - group: Reference
132
+ collapsed: true
133
+ items:
134
+ - path: reference/manifest
135
+ label: Manifest
136
+ - path: reference/namespaces
137
+ label: Namespaces
138
+ - path: reference/resolution
139
+ label: Resolution
140
+ - path: reference/security
141
+ label: Security
142
+
143
+ - group: Concepts
144
+ collapsed: true
145
+ items:
146
+ - path: concepts/how-it-works
147
+ label: How CNOS Works
148
+ - path: concepts/config-spectrum
149
+ label: The Config Spectrum
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kitsy/cnos-docs",
3
- "version": "1.9.2",
3
+ "version": "1.10.0",
4
4
  "description": "Source-of-truth CNOS documentation content for Astro Starlight and other static docs consumers.",
5
5
  "type": "module",
6
6
  "exports": {