Skip to main content

snapshot

The package installer for IST.

Installation​

npm install -g @microwiseai/snapshot

Commands​

install​

Install packages from an IST snapshot.

snapshot install <name> [options]

Arguments:

  • <name> - Snapshot to install (e.g., @ist/beta)

Options:

  • --replace - Converge to this version: remove previous-version packages no longer in this snapshot (shared packages are kept)
  • -d, --dry-run - With --replace, show what would be removed without changing anything
  • -y, --yes - With --replace, skip the removal confirmation prompt

Examples:

# Install IST
snapshot install @ist/beta

# Re-install and converge to the snapshot, removing stale packages
snapshot install @ist/beta --replace

# Preview what --replace would remove
snapshot install @ist/beta --replace --dry-run

current​

Show the currently installed snapshot and the versions of every package it provides.

snapshot current

Use this instead of relying on a hardcoded version list — it always reflects what is actually installed.

doctor​

Check if all prerequisites are satisfied.

snapshot doctor

setup​

Install missing prerequisites.

snapshot setup [options]

Options:

  • --auto - Non-interactive mode (for CI)
  • -d, --dry-run - Show what would be installed without installing

publish​

Publish a snapshot.json to the registry.

snapshot publish

access​

Package access management.

snapshot access sync [path]

Subcommands:

  • sync [path] - Sync package access levels with the license API

license​

License management.

snapshot license <command>

Subcommands:

  • activate <key> - Activate a license with a license key
  • status - Show the current license status
  • deactivate - Deactivate the current license
  • refresh - Refresh the session token for package downloads

Examples:

# Activate a license
snapshot license activate YOUR-LICENSE-KEY

# Check license status
snapshot license status

Package Model​

IST is distributed as a single snapshot: @ist/beta. Installing it brings in the full toolset (session tools, adapters, and the TDA/monitoring stack) in one step:

snapshot install @ist/beta

Package versions within the snapshot are managed for you and change over time — run snapshot current to see exactly what is installed.

Package Registry​

IST packages are hosted on the Microwise AI package registry, not the public npm registry. The snapshot CLI automatically configures npm to use the correct registry proxy during installation, so no manual registry setup is required.

Authentication​

Session monitoring and the detector agent require a one-time login:

detector-agent login

This opens a Google sign-in. See the detector-agent reference for details.