Skip to main content

​
Quickstart guide

​
Installation

Before installing, make sure you are using a node version between Node 18 <= x <= Node 22. Next, using npm, run the following command to globally install the slate cli: 
> npm i -g @randomlabs/slatecli
Once the slate cli is installed, you can run it with either of the following commands: 
> slate
or 
> slatecli

​
Account creation

You’ll be greeted with the following authentication windows. Either press enter to open in your current browser OR copy and paste the link into your browser. Next, you’ll set up an account, and sign up on the sign up page. Return to the Once you do this, you’ll see a window like the following: Slate requires a subscription to use. However, by using the code: WERE-SO-BACK you get 1 month of credits free To continue, you’ll need to start your subscription: Once the subscription is added, we can start using slate.

​
Your First Task

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

​
Step 1: Start Slate in Your Project

Navigate to your project directory and initialize Slate: 
cd /path/to/your/project
slate
This starts slate in the target repo.

​
Step 2: Try a Simple Task

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 ot understand how to improve it.

​
Next Steps

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

Using Slate

Learn about all of Slate’s features and commands.

Examples

See real-world examples and use cases.

​
Need Help?

If you encounter any issues:
  1. Check the troubleshooting section
  2. Reach out to our team