█▀▀ █▀▀ █▀█ █▀█ █ █ █ █  █▀▀ █   ▀█▀
▀▀▓ ▓░  ▓▀▄ █▀▓ ▓▀▄ ▓▀▄  ▓░  ▓░   ▓░
▀▀▀ ▀▀▀ ▀ ▀ ▀ ▀ ▀ ▀ ▀ ▀  ▀▀▀ ▀▀▀ ▀▀▀

Getting Started with Scrakk CLI

Scrakk is an open source AI coding agent that runs in your terminal. This guide will walk you through installation, configuration, and your first AI-assisted coding task.

Prerequisites

To use Scrakk in your terminal, you need:

  • A modern terminal emulator (WezTerm, Alacritty, Kitty, Ghostty)
  • API keys for the LLM providers you want to use (optional — free AI included)

Installation

The easiest way to install Scrakk is through the install script. It works on macOS, Linux, and Windows (WSL).

bash
curl -fsSL https://scrakk.art/install.sh | bash

You can also install via:

  • npm install -g scrakk-cli (Node.js)
  • brew install scrakk-cli/scrakk/scrakk (macOS)
  • cargo install scrakk-cli (Rust)
  • Download the binary from GitHub Releases

Configuration

With Scrakk, you can use any LLM provider by configuring your API keys. If you are new to using LLM providers, we recommend using Scrakk's built-in free AI (DeepSeek V4 Flash).

Using Free AI (Recommended for getting started)

No configuration needed. Scrakk includes free AI tokens every 6 days.

Adding your own API key

  1. Run the /connect command in the TUI
  2. Select your provider and visit the auth URL
  3. Sign in and copy your API key
  4. Paste it into the prompt

Initialize

Now that you have configured a provider, navigate to a project and run Scrakk.

bash
cd /path/to/project scrakk

Next, initialize Scrakk for the project by running the /init command. This will analyze your project and create an AGENTS.md file.

Usage

Ask questions

You can ask Scrakk to explain the codebase to you.

How is authentication handled in @src/auth.ts

Add features

You can ask Scrakk to add new features to your project. First, create a plan using Plan Mode (press Tab), then ask it to build.

Headless mode

For scripting, use headless mode with -p flag:

bash
scrakk -p "Fix the bug in src/utils/api.ts"

Next Steps