Contracts and edge cases

Platform spec article

Contracts and edge cases

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

Normative CLI flags and behaviors.

Global flags (instantiate)

Flag	Meaning
-o, --output <path>	Output directory or file (item templates)
-n, --name <string>	Primary name symbol (maps to default name symbol)
--symbol <id>=<value>	Repeatable symbol binding
--no-interactive	Fail if required symbols missing
--force	Allow non-empty output directory
--path <dir>	Template from local path
--git <url>	Template from git
--git-ref <ref>	Branch, tag, or commit
--git-subpath <dir>	Subdirectory within repo
--package <id>[@version]	Registry package (packageKind: template)
--project <Project.proj>	Host project for item templates
--allow-yanked	Continue after yanked warning
--strict-post-actions	Fail on unknown post-action id
--allow-project-manifest	Item template may write Project.proj

beskid new list flags

Flag	Meaning
--online	Include registry search results
--kind <project|workspace|item>	Filter by tags.type

Interactive

When stdin is a TTY:

• Prompt for each required symbol without a CLI value.
• Confirm overwrite when output exists (unless --force).
• Confirm proceed when template is yanked (unless --allow-yanked).

Examples

beskid new list --online
beskid new install beskid.templates.console
beskid new console -n MyApp -o ./MyApp
beskid new lib --symbol name=MyLib --no-interactive -o ./MyLib
beskid new --git https://git.example.com/templates --git-ref main --git-subpath lib -o ./Lib
beskid new contract --symbol contractName=Foo -o ./Src/Foo.bd --project ./App/Project.proj

Edge cases

• beskid new console without install: auto-install latest from registry when online.
• Ambiguous shortName: error listing matching package ids.
• CI: document beskid new ... --no-interactive in guides.