Skip to main content

​
Installing ScryCLI

Get ScryCLI up and running on your system in just a few minutes.

​
Prerequisites

Before installing ScryCLI, ensure you have the following installed:
  • Node.js version 16 or higher
  • npm, yarn, or pnpm package manager
  • A terminal application (Terminal, iTerm2, Windows Terminal, etc.)
ScryCLI works on macOS, Linux, and Windows. Make sure your Node.js installation is up to date for the best experience.

​
Install ScryCLI

You can install ScryCLI globally or as a local dependency in your project. Installing globally allows you to use the scrycli command from anywhere on your system: 
npm install -g scrycli

​
Local installation

If you prefer to install ScryCLI in a specific project: 
npm install scrycli
With a local installation, you’ll need to run ScryCLI using npx scrycli or add it to your package.json scripts.

​
Verify installation

After installation, verify that ScryCLI is installed correctly: 
scrycli
You should see the ScryCLI welcome screen with the large “SCRYCLI” banner:
Screenshot2026 03 03113848

​
First-time setup

When you run ScryCLI for the first time, you’ll be guided through a setup process:
1

Authentication

Press Enter when prompted to sign in. This will open your browser to https://www.scrycli.tech/token.
🔐 Press [Enter] to Signin to your account
2

Get your token

After signing in on the website, copy your authentication token.
🌐 Browser opened at https://www.scrycli.tech/token
📥 Paste your token here and press [Enter]:
3

Paste token

Return to your terminal and paste the token when prompted, then press Enter.
> [paste your token here]
4

Select AI provider

Choose your preferred AI provider from the list:
  • OpenAI
  • StepFun
  • Qwen
  • ArceeAI
  • Mistral
  • Zai
5

Select model

Pick a specific model from your chosen provider. Recommended options are marked in the list.
Keep your authentication token secure. Never share it or commit it to version control. ScryCLI stores it in ~/.scrycli/config.json on your system.

​
Configuration file

ScryCLI stores its configuration in your home directory: 
~/.scrycli/config.json
The configuration file contains:
  • Your authentication token and user ID
  • Selected AI model provider and model name
  • Other preferences
You can manually edit this file to change settings, or use the built-in /model and /logout commands.

​
Updating ScryCLI

To update to the latest version of ScryCLI: 
npm update -g scrycli

​
Troubleshooting

​
Command not found

If you get a “command not found” error after global installation:
  1. Check that your npm global bin directory is in your PATH: 
    npm config get prefix
  2. Add the bin directory to your PATH in your shell configuration file (.bashrc, .zshrc, etc.): 
    export PATH="$(npm config get prefix)/bin:$PATH"

​
Permission errors

If you encounter permission errors during installation on macOS or Linux: 
sudo npm install -g scrycli
Or configure npm to install global packages in your home directory: 
mkdir ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH

​
Token verification failed

If you receive an “Invalid token” error:
  • Ensure you copied the complete token from the website
  • Check that there are no extra spaces or line breaks
  • Try generating a new token from https://www.scrycli.tech/token

​
What’s next?

Now that ScryCLI is installed, head over to the quickstart guide to learn how to use it with real examples.