Skip to content

install.md

Latest commit

 

History

History
56 lines (39 loc) · 1.02 KB

install.md

File metadata and controls

56 lines (39 loc) · 1.02 KB
Raw

Install

Requirements

  • Node.js 22 or newer
  • npm
  • a ComPress store admin account
  • permission to create store CLI API keys

Check your runtime:

node --version
npm --version

Install From GitHub

Use this path while the public npm package is not yet published:

npm install -g github:lyc-aon/compress-store-agent-cli
compress doctor --json

To update, rerun the same install command.

Install From npm

Use this path after @compress/cli is published:

npm install -g @compress/cli
compress doctor --json

To update:

npm install -g @compress/cli@latest
compress upgrade status --json

compress upgrade status reports the install channel and recommended package-manager command. The CLI does not self-update because npm, Homebrew, Scoop, WinGet, and release archives own their installed files.

Verify

compress doctor --json
compress mcp bundles

doctor is safe to run. It reports profile, PATH, Node, and credential-store status without printing token secrets.