@kuandotdev/indicator

Bun-compiled launcher and npm wrapper CLI for Indicator.

This package is a production-shaped bootstrapper. The npm indicator command runs a bundled Bun standalone executable for the current platform. It does not replace the Python runtime yet. It wraps the existing repo commands for install, uninstall, diagnostics, MCP/agent import, market data, model forecast checks, Redis temp-cache checks, and 24-hour local temp artifact cleanup. The npm package ships binary launchers instead of a visible project source snapshot. The Bun executable embeds a compressed runtime snapshot and extracts it into ~/.indicator during install/update, so users do not need GitHub repository access to install the tool.

Installation

Recommended one-command setup:

npx -y @kuandotdev/indicator@latest install

This is the easiest path for a new machine. It runs the indicator install wizard directly from npm, without requiring a permanent global package first. The installer extracts the embedded Indicator runtime into ~/.indicator, installs Miniforge when no conda is available, creates the indicator conda env, installs the Python/runtime libraries, downloads Playwright Chromium, and then opens the setup flow. By default the npm install path configures all supported agent platforms, so users do not need to select a platform. It detects the preferred agent language from LC_ALL, LC_MESSAGES, or LANG; on macOS it also falls back to System Settings language (AppleLanguages / AppleLocale), so Traditional Chinese maps to zhtw and English maps to en.

Setup continues through TradingView login, PostgreSQL pgvector, and Redis cache checks. On macOS, when no DATABASE_URL or REDIS_URL is configured, setup can install/start Docker Desktop with Homebrew or a direct Docker Desktop download, then create local PostgreSQL pgvector and Redis containers.

Check the install with the same one-off npm path:

npx -y @kuandotdev/indicator@latest post-install-check

If you want a permanent global command instead, install the wrapper first:

npm i -g @kuandotdev/indicator

Then run the actual setup:

indicator install
indicator post-install-check

npm i -g @kuandotdev/indicator only installs the lightweight indicator command. The package intentionally has no npm install lifecycle script, so npm allow-scripts policies do not block install. Setup starts when you run indicator install, or when you use the one-command npx form above. Plain indicator install also defaults to all supported agent platforms; pass --platform pi, --platform claude-desktop, or another supported platform to limit setup. Re-running indicator install refreshes the npm-managed project copy while preserving .env, config/indicator.yaml, browser sessions, temp files, screenshots, Pine scripts, and data exports.

The command launcher is built with Bun during package publishing. The npm tarball contains macOS binary launchers, a tiny platform-selection shim, package metadata, and this README. The shim runs the matching platform executable and only falls back to the Node wrapper in local development trees where the wrapper source is present. Agent MCP configs use this same launcher as indicator mcp; the Python MCP server remains internal to the installed runtime instead of being the public agent entrypoint.

No manual Miniforge or conda install is required. To opt out of automatic Miniforge bootstrap, set INDICATOR_AUTO_INSTALL_MINIFORGE=0. The default Miniforge location is ~/.indicator/miniforge3; override it with INDICATOR_MINIFORGE_DIR=/path/to/miniforge3.

To opt out of automatic Docker Desktop bootstrap for local PostgreSQL/Redis, set INDICATOR_AUTO_INSTALL_DOCKER=0. To tune Docker startup waiting, set INDICATOR_DOCKER_START_TIMEOUT=240.

Update

If you installed with the one-command npx path and did not install a permanent global wrapper, update with the same one-off npm path:

npx -y @kuandotdev/indicator@latest update
npx -y @kuandotdev/indicator@latest post-install-check

This fetches the latest published wrapper, refreshes the local Indicator project copy in ~/.indicator, and reruns setup in update mode while preserving local .env, config/indicator.yaml, browser sessions, temp files, screenshots, Pine scripts, and data exports.

Update the global npm package:

npm update -g @kuandotdev/indicator
indicator update

npm update updates the lightweight wrapper. indicator update refreshes the local Indicator project copy and reruns setup in update mode.

Use the scoped package name for global npm updates. npm -g update indicator targets a different unscoped package name.

update refreshes the npm-bundled Indicator project copy, then reruns the installer. It preserves local .env, config/indicator.yaml, browser sessions, temp files, screenshots, and Pine scripts. If existing DATABASE_URL or REDIS_URL values are present, update reuses them: the PostgreSQL pgvector news schema is merged additively and Redis cache keys are checked, not flushed.

At runtime, vector and cache status/search/read/write commands try to restart Docker Desktop and existing Indicator-managed localhost containers (indicator-pgvector, indicator-redis) before connecting. Set INDICATOR_AUTO_START_LOCAL_SERVICES=0 to disable this behavior.

Version Check

Before normal commands run, the wrapper checks the latest npm version. If a newer @kuandotdev/indicator is available, interactive terminals are prompted to update. Non-interactive agent runs print the recommended update command so the agent can ask the user before updating.

Check explicitly anytime:

indicator update-check
indicator update-check --json

Disable the check when needed:

INDICATOR_SKIP_VERSION_CHECK=1 indicator status

Manual repair/full wizard commands remain available:

indicator update-check
indicator install
indicator update
indicator login
indicator session-check
indicator post-install-check
indicator mcp

Binary Build

Package publishing builds a Bun standalone launcher before npm pack. Build the current platform locally with:

npm run build:binary

Build specific targets with:

npm run build:binary -- --target darwin-arm64
npm run build:binary -- --target linux-x64

Use npm run clean:binary to remove generated launchers and the generated archive module. The binary packages the npm launcher plus an embedded compressed runtime snapshot; the current Indicator market-data/MCP/browser runtime still uses the Python project extracted into ~/.indicator.

Experimental platform package generation is available for future multi-package publishing:

npm run build:binary
npm run build:platform-packages

Uninstall

indicator uninstall --full

Full uninstall removes agent integrations, local runtime artifacts, the conda environment, and the Indicator-owned PostgreSQL news vector table when DATABASE_URL is configured. It also deletes Indicator-owned Redis cache keys when REDIS_URL is configured.

Cache Cleanup

indicator cache-cleanup

This prunes managed local temp/YYYYMMDD_HHMMSS/... analysis artifacts older than 24 hours. Redis cache entries use TTLs capped by the same 24-hour retention setting.