de>scriptor
Installation

Get Devscriptor
Up and Running

Multiple installation methods for every platform. Choose the one that works best for your environment.

macOS
Linux
Windows
Prerequisites

Before You Begin

Ensure your system meets these requirements before installing Devscriptor.

Rust
Required

Version: 1.75+

Required for building from source with Cargo

Install Rust →

C/C++ Compiler
Required

Version: GCC/Clang/MSVC

Required for compiling tree-sitter parsers

xcode-select --install

Git
Required

Version: 2.0+

Required for repository operations

Docker

Version: 20.10+

Optional - for container-based installation

Installation Methods

Choose Your Method

7 different ways to install Devscriptor. Pick the one that fits your workflow.

Quick Install (Recommended)

One-line installer for macOS and Linux

curl -fsSL https://devscriptor.io/install.sh | sh

What this does:

  • Detects your operating system and architecture
  • Downloads the appropriate binary
  • Installs to /usr/local/bin or ~/.local/bin
  • Sets up necessary permissions
First-Time Setup

Complete the Setup

After installation, complete these steps to get Devscriptor fully configured.

1

Download Embedding Model

Required for semantic code search

devscriptor model download

Downloads the jina-embeddings-v2-base-code model (~300MB) for local semantic search. This is a one-time download.

2

Configure MCP (Optional)

Set up Claude Desktop, Cline, or other MCP clients

devscriptor mcp setup

Automatically configures MCP clients with the correct server path and settings.

3

Scan Your First Project

Create your first codebase database

devscriptor scan /path/to/your/project

This creates a .devscriptor.db file with the complete knowledge graph of your codebase.

Verification

Verify Installation

Run these commands to confirm Devscriptor is installed correctly.

Check CLI version

devscriptor --version
Expected: devscriptor 0.1.0

View available commands

devscriptor --help
Expected: Usage: devscriptor [OPTIONS] <COMMAND>

Verify MCP server installation

devscriptor mcp --version
Expected: devscriptor-mcp 0.1.0
Updating

Keep Devscriptor Updated

Update commands for each installation method.

curl

curl -fsSL https://devscriptor.io/install.sh | sh

homebrew

brew upgrade devscriptor

apt

sudo apt update && sudo apt upgrade devscriptor

scoop

scoop update devscriptor

winget

winget upgrade Devscriptor.Devscriptor

docker

docker pull vladimirpesic/devscriptor:latest

cargo

cargo install --path crates/cli --force && cargo install --path crates/mcp --force
Troubleshooting

Common Issues

Solutions to common installation and setup problems.

Permission denied during installation

Ensure you have write access to /usr/local/bin or use a custom installation directory:

curl -fsSL https://devscriptor.io/install.sh | sh -s -- --install-dir ~/.local/bin

tree-sitter compilation errors

Install C/C++ compiler and development headers:

xcode-select --install

Command not found after installation

Add the installation directory to your PATH:

export PATH="$HOME/.local/bin:$PATH" >> ~/.zshrc

Embedding model download fails

Check your internet connection and try manual download:

devscriptor model download --force

LSP server not detected

Run the LSP detection command:

devscriptor lsp detect