Design model

Platform spec article

Design model

Back to beskid new command ◎ Open feature in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

ADRs (3)

1. 0001-beskid-new-command-name beskid new command Accepted

   beskid new command

   Context

   Scaffolding entrypoint.

   Decision

   Command must be beskid new.

   Consequences

   See project-templates ADRs.

   Verification anchors

   CLI command table.

   Open full ADR page

2. 0002-interactive-and-noninteractive Interactive modes Accepted

   Interactive modes

   Context

   Scaffolding entrypoint.

   Decision

   Support interactive and non-interactive instantiation.

   Consequences

   See project-templates ADRs.

   Verification anchors

   CLI tests.

   Open full ADR page

3. 0003-update-check-on-instantiate Update on instantiate Accepted

   Update on instantiate

   Context

   Scaffolding entrypoint.

   Decision

   Run template update check when online.

   Consequences

   See project-templates ADRs.

   Verification anchors

   Mock registry test.

   Open full ADR page

Articles

• Contracts and edge cases Flags, interactive behavior, and edge cases for `beskid new`. article Standard Reviewed Thu May 21
• Design model CLI cache layout, registry integration, and option model for `beskid new`. article Standard Reviewed Thu May 21

History

0 revisions (git unavailable at build; counts may be empty)

Open full history on GitHub

No commits recorded for this path.

Completeness

OKfeature · 6 SpecSection(s) · 0 H2 heading(s)

Section id	Required	Found
what-this-feature-specifies	yes	yes
implementation-anchors	yes	yes

Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).

Related spec docs

• Feature
  beskid new command

  Parent feature hub

Purpose and scope

Tooling-side state and paths for the beskid new command family.

Cache directory

Path (under user config root)	Content
templates/installed/<identity>/	Extracted template tree + manifest.snapshot.json
templates/git/<hash>/	Git clone caches
templates/registry-index.json	Optional index of last-known registry versions for update checks

Exact config root must match other Beskid CLI state (same resolver as beskid pckg auth config).

Install record

manifest.snapshot.json stores:

• identity, shortName, packageId, resolvedVersion, checksum, installedAt
• source: registry | path | git
• yanked: boolean snapshot at install time

Update check

On beskid new <shortName> (and --package):

1. Read installed resolvedVersion.
2. Query registry for latest non-yanked version.
3. If newer: print update message (non-fatal).
4. If current is yanked: print warning (see contracts).

Online vs offline

Mode	Behavior
Registry reachable	Prefer download of beskid.templates.*; update check enabled
Offline	Use cache only; list shows installed; warn if update check skipped

Exit codes

Code	Meaning
0	Success
1	User error (validation, collision)
2	Engine or I/O failure
3	Registry auth or network failure when required

Code anchors

• compiler/crates/beskid_cli/src/cli.rs — subcommand registration
• compiler/crates/beskid_pckg — download API