​
Quick Start Guide

Get up and running with Arc Memory in minutes. This guide will walk you through the essential steps to start using Arc Memory with your code repository.
Beta Release: Arc Memory SDK is currently in beta. We’re actively gathering feedback and improving the platform.
Prerequisites: Make sure you have installed Arc Memory before proceeding.

​
5-Minute Quick Start

1

Navigate to your repository

First, open a terminal and navigate to your Git repository:
cd /path/to/your/repo
Arc Memory works best when run from the root of your Git repository.
2

Authenticate with GitHub

Set up GitHub authentication to access repository data:
arc auth gh
This will open a browser window for GitHub authentication. If you prefer to use a token directly:
arc auth gh --token YOUR_GITHUB_TOKEN
Authentication is required to access GitHub issues, PRs, and other metadata.
3

Build the knowledge graph

Build a complete knowledge graph for your repository:
arc build
4

Verify the graph

Check the status and integrity of your knowledge graph:
arc doctor
This command shows statistics about your graph and identifies any potential issues.
5

Trace file history

Now you can trace the history of any file and line in your codebase:
arc trace file path/to/file.py 42
This will show the complete history of line 42 in the specified file, including:
  • Commits that modified the line
  • Pull requests that introduced or changed the line
  • Related issues and discussions
  • Architecture decisions that affected the line

​
Complete Example

Here’s a complete workflow example you can copy and paste: 
# Navigate to your repository
cd /path/to/your/repo

# Authenticate with GitHub
arc auth gh

# Build the knowledge graph
arc build

# Check the graph status
arc doctor

# Trace history for a specific file and line
arc trace file path/to/file.py 42

​
What’s Next?

CLI Reference

Learn all the available commands and options

API Reference

Use Arc Memory programmatically in your code

Usage Examples

Explore real-world usage scenarios