> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcore.me/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting Started

> Install and run your personal AI OS in minutes. Open source, self-hosted, yours forever.

CORE is your personal AI OS. It watches your apps and AI sessions, remembers what matters across every conversation, and acts — directly in your tools or by spawning coding and browser agents — without you staying in the loop for every step.

***

## Choose your path

| I want to...              | How                                              |
| ------------------------- | ------------------------------------------------ |
| Try it on my machine      | Run the one-step install below (requires Docker) |
| Deploy on a server or VPS | One-click Railway deploy                         |
| Use the Mac app           | [Join the waitlist](https://www.getcore.me/)     |

***

## Install and start CORE

```bash theme={null}
npm install -g @redplanethq/corebrain && corebrain setup
```

The setup wizard asks for an install directory, AI provider, API key, and chat model. It generates secrets, starts the stack, and opens `http://localhost:3033`.

Most local installs take a few minutes once Docker is running.

**Requirements:** Docker 20.10+, Docker Compose 2.20+, 4 vCPU / 8GB RAM

**Or deploy on Railway:**

[![Deploy on Railway](https://railway.app/button.svg)](https://railway.com/deploy/core)

[Full self-hosting guide →](/self-hosting/setup)

***

## Connect a gateway

The gateway is what lets CORE drive coding agents, your browser, and terminal commands — even when your laptop is closed.

```bash theme={null}
corebrain login
corebrain gateway setup
```

Run this on your laptop, a Docker host, or a Railway service. Once it's connected, CORE can spawn Claude Code or Codex sessions, run terminal commands, and open PRs on your behalf.

***

## Your first task

Once CORE is running:

1. Open the **Scratchpad** — your daily page at `http://localhost:3033`
2. Type `[ ] Summarize my open GitHub issues` (or any task you'd normally handle yourself)
3. CORE picks it up within 3 minutes, gathers context from your connected apps and memory, and drafts a plan
4. Approve the plan — CORE runs it and brings back the result

That's the core loop: you write what needs doing, CORE owns it end to end.

***

## CORE in action

### Say it, come back to a PR.

Press Ctrl+Option, speak: *"Fix the race condition in the checkout flow from issue #312."*

CORE loads the issue, pulls related commits and Slack threads, drafts a plan, and runs a Claude Code session. You come back to a diff.

### Write it at night, review it in the morning.

Scratchpad: `[ ] Work through tonight's backlog starting at 11pm`

CORE pulls from Linear, GitHub, and memory, prioritizes, and works through it while you sleep. Smooth runs are waiting for your review. Stuck sessions come back with one tight question, not a stalled tab.

### Message it from anywhere.

WhatsApp from the airport: *"Ship the auth refactor."*

CORE already knows the branch, the context, and your preferences. It is running in Railway. It kicks off the session before you board.

### Investigate alerts before they become incidents.

Sentry fires at 2am. CORE investigates, pulls related traces and prior incidents from memory, proposes a fix, and pings you on Slack: "Issue #847, fix proposed, awaiting your review." You approve from your phone.

### Get a brief that already knows your week.

Recurring task, every morning at 8am. CORE pulls from email, GitHub, Linear, and Slack, surfaces what actually needs attention, skips what does not, and turns follow-ups into tasks automatically.

***

## Next steps

<CardGroup cols={3}>
  <Card title="Connect apps" icon="plug" href="/toolkit/overview">
    50+ connectors — GitHub, Linear, Slack, Gmail, and more.
  </Card>

  <Card title="Memory" icon="database" href="/memory/overview">
    How CORE remembers across every tool and conversation.
  </Card>

  <Card title="Skills" icon="wand-magic-sparkles" href="/skills/overview">
    Reusable instructions that fire automatically based on context.
  </Card>
</CardGroup>
