@treeseed/cli
v0.6.28
Published
Operator-facing Treeseed CLI package.
Downloads
4,740
Readme
@treeseed/cli
Operator-facing Treeseed CLI package.
This package publishes the treeseed binary. @treeseed/sdk owns the reusable workflow and runtime capabilities, @treeseed/core owns integrated local platform orchestration, and @treeseed/cli owns argv parsing, command help, terminal formatting, command handlers, and the installable executable surface.
Requirements
- Node
>=22 - npm as the canonical package manager for install, CI, and release flows
Install
Install the CLI with its runtime dependencies:
npm install @treeseed/cli @treeseed/core @treeseed/sdk@treeseed/cli is a thin installable wrapper over @treeseed/sdk workflow and operations interfaces plus the @treeseed/core runtime namespaces. treeseed dev and treeseed agents ... resolve and delegate to the tenant-installed or sibling-workspace @treeseed/core runtime. In normal consumer installs, npm resolves the runtime dependencies automatically.
Workflow guarantees:
treeseedis the only supported project-management surface for market and any checked-outpackages/sdk,packages/core, andpackages/clirepos.treeseed switchrequires clean worktrees, mirrors the task branch into checked-out package repos, and only pushes the market branch on branch creation.treeseed saveis the canonical recursive checkpoint command: it verifies, commits, and pushes dirty package repos in dependency order before saving the market repo.treeseed stagesquash-merges task branches intostagingacross package repos first, refreshes market submodule pointers to packagestagingheads, then stages the market repo.treeseed closerecursively archives and deletes matching task branches across market and checked-out package repos.treeseed releaseonly bumps, tags, and publishes changed packages plus internal dependents, then syncs market production to packagemainheads.- Every mutating workflow command supports
--plan;--dry-runis only an alias where it still exists for compatibility. - Interrupted workflow runs are journaled under
.treeseed/workflow; usetreeseed recoverto inspect them andtreeseed resume <run-id>to continue a resumable run.
After installation, the published binary is available as:
treeseed --helpPrimary Workflow
The main workflow commands exposed by the current CLI are:
treeseed status [--json]treeseed configtreeseed tasks [--json]treeseed switch <branch-name> [--preview]treeseed devtreeseed save [--preview] [--plan] "<commit message>"treeseed stage "<resolution message>"treeseed close "<close reason>"treeseed release --major|--minor|--patch [--plan]treeseed resume <run-id>treeseed recovertreeseed destroy --environment <local|staging|prod> [--plan]
Support utilities such as treeseed rollback, treeseed doctor, treeseed auth:*, treeseed template, treeseed sync, treeseed lint, treeseed test, treeseed build, service helpers, and treeseed agents ... remain available.
Use treeseed help for the full command list and treeseed help <command> for command-specific usage, options, and examples.
Common Commands
treeseed status
treeseed config
treeseed switch feature/search-improvements --plan
treeseed switch feature/search-improvements --preview
treeseed dev
treeseed save --preview "feat: add search filters"
treeseed stage "feat: add search filters"
treeseed release --patch
treeseed recover
treeseed status --jsonAgent-Safe Workflow
Use planning mode before any destructive or multi-repo mutation:
treeseed switch feature/search-improvements --plan --json
treeseed save --plan "feat: add search filters" --json
treeseed stage --plan "feat: add search filters" --json
treeseed release --patch --plan --jsonIf a workflow stops partway through, inspect the journaled state and resume from the recorded run:
treeseed recover
treeseed resume <run-id>In a full checked-out workspace, treeseed tasks, treeseed status, and treeseed doctor also report package-branch drift, dirty embedded repos, active workflow locks, and interrupted runs.
Maintainer Workflow
All package maintenance commands are npm-based and run from the cli/ package root. This package verifies the published command surface, parser/help behavior, and packaged artifact shape.
Install dependencies:
npm installBuild the published package output:
npm run buildRun the package test suite:
npm testRun full release verification:
npm run release:verifyThe release verification flow is intentionally stricter than a normal test run:
- Build
dist - Validate publishable output for forbidden workspace references
- Assert the published artifact only contains the thin wrapper entrypoints
- Run the CLI wrapper test suite
- Pack the CLI tarball
- Smoke-test the packed install by running
treeseed --helpfrom the packed artifact
CI And Publishing
The GitHub Actions workflows under .github/workflows/ assume this package is the repository root for the standalone CLI repository.
ci.ymlusesnpm ci,npm run build,npm test, andnpm run release:verifypublish.ymluses the same verification path before publishing to npmpublish.ymlvalidates that the pushed tag matches the package version beforenpm publish
Release tags must use this format:
<version>For example, package version 0.1.0 publishes from tag 0.1.0.
Notes
package-lock.jsonshould be committed and kept current sonpm ciremains reproducible in CI and release jobs.- The README intentionally documents the command surface at a high level. The canonical source of operation identity and semantics is
@treeseed/sdk, while@treeseed/cliowns argv parsing, help rendering, and terminal formatting.
