Command line (CLI)

Install

The CLI is a single workspace package with no runtime dependencies—just Node built-ins. It needs Node 20 or newer. Install the public package from npm, or build from source when working on the monorepo.

npm install -g @winlayer/cli
winlayer --version

# Local development
cd packages/cli
npm install
npm run build
npm link          # puts `winlayer` on your PATH

winlayer --version

# Optional local/package-registry artifact
npm pack

command not found: winlayer after a global install means npm's global bin directory isn't on your PATH. Print it with npm prefix -g and add that folder's bin to your shell profile.

Sign in

Run winlayer login and pick a method — or just run winlayer, which signs you in if needed and then drops you straight into the interactive session.

Skip the menu when you already know which one you want:

winlayer login                      # menu
winlayer login --method device      # show a code to approve elsewhere
winlayer login --no-browser         # same, without trying to open a browser
winlayer login --key wl_live_...    # non-interactive

Device login never sends your credential over the wire in the clear: the terminal generates a key pair, sends only the public key, and the credential comes back encrypted to it. Confirm which workspace you landed in with winlayer whoami.

Where the credential lives

In ~/.winlayer/config.json, written 0600 — owner read/write only, the same convention the aws and gh CLIs use. Environment variables always win over the file, so CI and one-off shells stay stateless:

winlayer logout revokes a browser-created CLI session and removes it locally. A developer API key is only forgotten on that machine; revoke it in the developer console to disable it everywhere. Manage developer keys on /developer.

Two ways to run it

Interactive. winlayer with no command opens the command center: a prompt that keeps your session, so you can chain questions without re-authenticating each time.

Press / or Ctrl K at an empty prompt to open the searchable command center. Search by command, description, or category; use the arrow keys to move, press Tab to fill a command into the prompt, or press Enter to run it immediately. Keys 1–4 launch the four Start Here actions directly.

One command, then exit. winlayer <command> runs and returns an exit code — this is the form to use in scripts, cron jobs, and CI.

Commands

opps, opp, overview, and query are accepted as shorthand. daily is an alias for agent. Run winlayer help for the same list in your terminal.

Global options

Scripting it

--json works on every data, agent, model, and approval command, so the CLI composes with whatever you already use. Nothing prompts when a key is supplied by environment, which is what makes it safe in CI:

export WINLAYER_API_KEY="wl_live_..."

# Everything worth pursuing this morning
winlayer opportunities --min 60 --json | jq '.opportunities[] | {title, fitScore, winProbability}'

# Run the Daily Growth Agent from cron and mail yourself the result
winlayer agent --json > /tmp/daily.json

# Export every signal page without replacing an existing file
winlayer export signals --format jsonl --output signals.jsonl

# Query the scoped, read-only GraphQL API
winlayer graphql 'query { apiVersion }' --json

Commands exit non-zero on failure, so set -e behaves the way you expect. The CLI talks to the same public API documented under Authentication — the rate limits that apply to a key apply here too.