Install Agentic OS

Local install

Install Agentic OS locally with the guided installer.

This guide installs Agentic OS locally with the guided installer.

Before you start, check Prerequisites.

Create a blank folder

Create a new folder anywhere you want.

You can name it anything. For example:

my-agentic-os

Open VS Code, choose Open Folder, and select that folder.

Run the installer

Open a terminal inside VS Code.

On Windows, use PowerShell. Do not use Git Bash for the installer.

Run:

npx @scrapes/installer

The installer opens a guided menu.

If GitHub access is already set up, the installer uses it. If it needs a token, it asks for one during setup.

Do not paste real tokens into docs, screenshots, or committed files.

Choose Agentic OS

In the installer menu:

  1. Choose Install Agentic OS.
  2. Choose the folder you opened in VS Code.
  3. Follow the guided setup.

The installer creates an agentic-os folder inside your chosen folder.

It also checks for required tools, shows available skills, and connects them to Claude Code.

The five core skills are always installed. Some optional skills may ask for an API key. Most skills still work without keys.

Add API keys to .env only when you need them. Check .env.example for the full list of supported keys.

Bring existing work

If you already have projects, folders, files, or notes, keep their current structure.

Install Agentic OS into a dedicated blank folder. Then move your existing work inside projects/.

Add a short note in CLAUDE.local.md that explains where the old work lives and what it contains.

Do not edit base CLAUDE.md for personal project notes. Base files are updated by Agentic OS. Read Custom edits for the safe local layer.

Expected result

Setup is complete when the installer finishes and the new agentic-os folder exists.

Your terminal may still be one level above that folder.

Next: First run

On this page