Getting Started

Get ArchiCore up and running in under 5 minutes.

Prerequisites

• Node.js 18 or higher
• npm or yarn
• A GitHub account (for GitHub integration)

Option 1: Web Interface

The easiest way to get started is through the web interface.

Step 1: Create an Account

1. Go to ArchiCore
2. Click Sign Up
3. Register with email or sign in with GitHub

Step 2: Connect a Repository

1. Click Add Project in the sidebar
2. Select the GitHub tab
3. Click Connect with GitHub and authorize ArchiCore
4. Select a repository from the list
5. Choose a branch and click Add Project

Step 3: Wait for Indexing

ArchiCore will automatically index your codebase. This usually takes 1-5 minutes depending on project size.

Step 4: Start Exploring

Once indexed, you can:

• View the architecture visualization
• Ask questions using the AI assistant
• Run analysis commands

---

Option 2: CLI

For developers who prefer the command line.

Step 1: Install

npm install -g archicore

Step 2: Login

archicore login

This opens a browser window to authenticate.

Step 3: Initialize Project

cd /path/to/your/project
archicore init

Step 4: Index Your Code

archicore
# Then type: /index

Step 5: Start Using

# Interactive mode
archicore

# Or run commands directly
archicore search "authentication logic"
archicore analyze src/auth/

---

What's Next?

Learn CLI Commands

Master the full power of ArchiCore CLI.

View Commands →

GitHub Integration

Set up automatic analysis on every push.

Setup Guide →

---

Troubleshooting

"Command not found: archicore"

Make sure npm global bin is in your PATH:

# Check npm bin location
npm bin -g

# Add to PATH (bash/zsh)
export PATH="$(npm bin -g):$PATH"

"Authentication failed"

1. Run archicore logout
2. Run archicore login again
3. Complete the browser authentication

"Indexing stuck"

Large projects may take longer. Check progress with:

archicore status

If stuck for more than 30 minutes, try:

archicore index --force

---

Need help? Contact support via the Report Issue form in the app.