Skip to content

Commit e295871

Browse files
Align core info contract references
Assisted-by: GitHub Copilot (model: unknown, autonomous) Co-authored-by: nicolehaugen <10600161+nicolehaugen@users.noreply.github.com>
1 parent 0946f63 commit e295871

6 files changed

Lines changed: 14 additions & 14 deletions

File tree

‎docs/reference/core-info.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# Core Inventory
1+
# Core Info
22

33
The `specify core` command group exposes read-only information about Spec Kit's baked-in ("core") baseline — the commands, templates, and helper scripts that ship inside the CLI package itself. Presets, extensions, integrations, and project-scoped assets are intentionally **not** included; use their dedicated commands (`specify preset`, `specify extension`, `specify integration`) for those.
44

5-
Core-inventory output is deterministic and byte-identical across runs, so downstream tools can safely diff, hash, or cache it.
5+
Core info output is deterministic and byte-identical across runs, so downstream tools can safely diff, hash, or cache it.
66

7-
## List the Core Inventory
7+
## Inspect Core Info
88

99
```bash
1010
specify core info --json
1111
```
1212

1313
| Option | Description |
1414
| ------------- | -------------------------------------------------------------------- |
15-
| `--json` | **Required.** Emit the inventory as JSON on stdout. |
15+
| `--json` | **Required.** Emit core info as JSON on stdout. |
1616

1717
The `--json` flag is mandatory. A human-readable table format is intentionally not offered — the command is designed for programmatic consumption by external tools and other Spec Kit surfaces. Invoking `specify core info` without `--json` exits non-zero with a hint pointing at the flag.
1818

@@ -68,7 +68,7 @@ specify core info --json | jq '.commands[] | select(.name == "plan")'
6868

6969
- Alphabetical ordering by `name` within each section.
7070
- Fixed top-level key order: `commands`, `templates`, `scripts`.
71-
- Fields inside each entry are emitted in a fixed order (see the schema at [`specs/001-core-inventory/contracts/core-info-schema.json`](https://github.com/github/spec-kit/blob/main/specs/001-core-inventory/contracts/core-info-schema.json)).
71+
- Fields inside each entry are emitted in a fixed order (see the schema at [`specs/001-core-info/contracts/core-info-schema.json`](https://github.com/github/spec-kit/blob/main/specs/001-core-info/contracts/core-info-schema.json)).
7272
- Path separators are always forward-slashes, even on Windows.
7373

7474
## Failure Modes

‎docs/toc.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
href: reference/overview.md
3030
- name: Core Commands
3131
href: reference/core.md
32-
- name: Core Inventory
32+
- name: Core Info
3333
href: reference/core-info.md
3434
- name: Integrations
3535
href: reference/integrations.md

‎src/specify_cli/__init__.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,7 @@ def _require_specify_project() -> Path:
553553
raise typer.Exit(1)
554554

555555

556-
# ===== Core Inventory Commands =====
556+
# ===== Core Info Commands =====
557557

558558
# specify core * — see specify_cli/core/_commands.py
559559
from .core._commands import register as _register_core_cmds # noqa: E402

‎src/specify_cli/core/__init__.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
the wheel (`specify_cli/core_pack/`) or the source checkout (repo root).
66
77
The output is the exact shape validated by
8-
``specs/001-core-inventory/contracts/core-info-schema.json``. See
9-
``specs/001-core-inventory/data-model.md`` for authoritative field types.
8+
``specs/001-core-info/contracts/core-info-schema.json``. See
9+
``specs/001-core-info/data-model.md`` for authoritative field types.
1010
1111
Every asset carries a stable identifier per companion issue #4210:
1212
``core:_:{kind}:{name}``. Ordering: alphabetical by ``name`` within each

‎src/specify_cli/core/_commands.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""specify core * command handlers — app object and register() entry point.
22
3-
See ``specs/001-core-inventory/contracts/core-info-cli.md`` for the CLI
3+
See ``specs/001-core-info/contracts/core-info-cli.md`` for the CLI
44
contract (invocation syntax, streams, exit codes). See
5-
``specs/001-core-inventory/data-model.md`` for the emitted JSON shape.
5+
``specs/001-core-info/data-model.md`` for the emitted JSON shape.
66
"""
77
from __future__ import annotations
88

‎tests/test_core_info_command.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
"""CLI-level tests for ``specify core info --json`` via Typer's CliRunner.
22
33
Contract references:
4-
- ``specs/001-core-inventory/contracts/core-info-cli.md``
5-
- ``specs/001-core-inventory/contracts/core-info-schema.json``
4+
- ``specs/001-core-info/contracts/core-info-cli.md``
5+
- ``specs/001-core-info/contracts/core-info-schema.json``
66
77
Deferred (companion #4212): cross-reference integration tests that join this
88
command's output against ``specify artifact info --json``. See tasks.md T029.
99
"""
1010
# TODO(#4212): add a cross-reference integration test that joins
1111
# `specify core info --json` output against `specify artifact info --json`
12-
# once the companion command lands. See specs/001-core-inventory/tasks.md T029.
12+
# once the companion command lands. See specs/001-core-info/tasks.md T029.
1313
from __future__ import annotations
1414

1515
import json

0 commit comments

Comments
 (0)