Skip to content

README.md

Latest commit

 

History

History
82 lines (59 loc) · 3.3 KB

README.md

File metadata and controls

82 lines (59 loc) · 3.3 KB
Raw

mstack CLI

mstack installs and maintains Misbah Khursheed's Build Like This engineering workflow in a repository. It is safe to run against an existing project: setup previews its plan, adds missing assets, preserves user-owned documents by default, verifies the result, and records managed files in .mstack/manifest.json.

Install and start

Install mstack globally with npm:

npm install -g @imisbahk/mstack
mstack init

For a zero-install run, use:

npx @imisbahk/mstack@latest init

Inside an existing repository, the standard journey is:

mstack init
mstack ai setup
mstack validate

mstack init --dry-run previews repository changes. mstack ai setup --dry-run previews every runtime artifact and limitation. In automation, pass --yes plus explicit runtime IDs or --all.

What setup installs

mstack init installs:

  • product, architecture, feature, and decision templates when missing;
  • .mstack/config.json for project preferences;
  • .mstack/manifest.json for generated-file ownership and upgrade safety.

mstack ai setup installs the selected environments' repository guidance, prompts, skills, agents, hooks, and .mstack/templates/ reference library.

Existing planning documents are preserved. --force is the only path that intentionally replaces conflicting generated targets, and should be used after reviewing the dry run.

Everyday commands

Command Purpose
mstack init Initialize or safely refresh repository onboarding
mstack status Show methodology readiness and the next action
mstack explain Walk through the repository's installed workflow
mstack ai setup Configure detected or selected AI coding runtimes
mstack ai list Inspect runtime support and detection
mstack catalog Discover agents, skills, prompts, hooks, templates, packs, and task recipes
mstack pack List, inspect, recommend, add, and remove curated capability packs
mstack task Inspect and run policy-gated argv-only task recipes
mstack agent List installed specialists and runtime invocation guidance
mstack validate Verify planning readiness, ownership, and runtime integrity
mstack doctor Diagnose runtime, repository, permissions, and manifest health
mstack config Inspect or change layered configuration
mstack plugins Inspect installed capability contributions
mstack update Check and apply CLI updates

See the generated command reference for every option.

Output and automation

Interactive terminals receive color, progress, and one safe confirmation. Redirected output is stable and contains no animation. Use --no-color for plain terminal output and --json on setup, status, explain, doctor, validation, catalog, AI, and configuration inspection commands for a versioned machine-readable result.

Exit codes are stable:

Code Meaning
0 Completed or valid dry run
1 Operational or unexpected failure
2 Invalid input or configuration
3 A required non-interactive decision is missing
4 Repository validation failed

More information