Installation

Install the LynxPrompt CLI using your preferred package manager. Available for macOS, Windows, and Linux.

Prerequisites

Node.js 18 or later

Required for npm and npx installation. Not needed for Homebrew, Chocolatey, or Snap as they install Node.js as a dependency.

JavaScript Package Managers (Recommended)

The fastest way to install on any platform. Works on macOS, Windows, and Linux.

npm

npm install -g lynxprompt

yarn

yarn global add lynxprompt

pnpm

pnpm add -g lynxprompt

bun

bun add -g lynxprompt

Run without installing (npx)

npx lynxprompt wizard

Great for one-off usage or trying out the CLI without global installation.

Homebrew (macOS)

Install using the official LynxPrompt tap for Homebrew.

Add the tap and install

brew tap GeiserX/lynxprompt
brew install lynxprompt

Or in one command

brew install GeiserX/lynxprompt/lynxprompt

Update to latest version

brew update
brew upgrade lynxprompt

Chocolatey (Windows)

Install using Chocolatey package manager for Windows.

Note: Chocolatey packages go through a community moderation process. If the latest version isn't available yet, use npm instead.

choco install lynxprompt

Snap (Linux)

Install using Snap Store for Ubuntu and other Linux distributions.

Note: Snap packages may have additional sandbox restrictions. For full functionality, npm installation is recommended on Linux.

snap install lynxprompt

Verify Installation

After installing, verify that the CLI is working correctly:

$ lynxp --version
0.3.0

$ lynxp --help

🐱 LynxPrompt CLI
Generate AI IDE configuration files

Usage: lynxprompt [options] [command]

Commands:
  wizard    Generate AI config interactively (recommended)
  check     Validate AI config files (CI/CD)
  status    Show config status and tracked blueprints
  pull      Download and track a blueprint
  push      Push local file to cloud
  search    Search marketplace blueprints
  link      Link local file to cloud blueprint
  unlink    Disconnect file from cloud blueprint
  diff      Compare tracked files with cloud
  login     Authenticate with LynxPrompt

Uninstall

To remove the CLI, use the same package manager you used to install:

Package Manager	Uninstall Command
npm	`npm uninstall -g lynxprompt`
yarn	`yarn global remove lynxprompt`
pnpm	`pnpm remove -g lynxprompt`
bun	`bun remove -g lynxprompt`
Homebrew	`brew uninstall lynxprompt`
Chocolatey	`choco uninstall lynxprompt`
Snap	`snap remove lynxprompt`

Next: Authentication

Learn how to authenticate with LynxPrompt to access your blueprints.

Authentication