Quickstart Guide

Slate may not work on Windows. If you are on Windows, we recommend using WSL (Windows Subsystem for Linux).

Significant flashing and flickering has been observed in the TUI when running Slate inside tmux.

Installation

Run the following command to install Slate:

npm i -g @randomlabs/slate

Once installed, run Slate with:

slate

Let’s complete a simple task to get familiar with Slate.

Navigate to your project directory and initialize Slate:

cd /path/to/your/project
slate

This starts Slate in the target repo.

Ask Slate to help you with a specific task:

Please review the architecture of my entire codebase creating an ARCH.md and then give me ways I can improve it.

Slate will search through your files and analyze the entire codebase, and then review the results to understand how to improve it.

Now that you’re up and running, explore Slate’s full capabilities:

Learn about all of Slate’s features and commands.

If you encounter any issues: