CLI Installation

Install the StackShare CLI to scan your projects and automatically detect the tools you're using.

Prerequisites

• Node.js 18+ - Download from nodejs.org

Verify Node.js is installed:

node --version  # Should be v18 or higher

Quick Start (No Installation)

The fastest way to use the CLI is with npx - no installation required:

npx stackshare scan

This will scan your current directory and detect tools automatically.

Global Installation

For frequent use, install the CLI globally:

npm install -g stackshare

Or using pnpm:

pnpm add -g stackshare

Authentication

The CLI will prompt you to authenticate when you first try to post a stack. You have two options:

Browser Authentication

When prompted, the CLI opens a browser window for you to sign in. After authenticating, your API key is saved automatically.

API Key

You can also authenticate directly with an API key:

stackshare login <your-api-key>

Generate an API key from your account settings.

Verify Installation

Check that the CLI is installed correctly:

stackshare --version

Available Commands

stackshare scan [directory]   # Scan a directory for tools (default command)
stackshare login [api-key]    # Authenticate with StackShare
stackshare logout             # Remove stored authentication

Next Steps

Once installed, you can start scanning your projects:

Learn how to scan projects →