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

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.

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.

Build the knowledge graph

Build a complete knowledge graph for your repository:

arc build

Build Options

For faster updates after the initial build:

arc build --incremental

For faster updates after the initial build:

arc build --incremental

To limit the scope of the build:

arc build --max-commits 1000 --days 30

To specify a custom output location:

arc build --output /path/to/output.db

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.

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

Advanced Usage

Add Arc Memory to your CI/CD pipeline to keep your knowledge graph up-to-date:

# GitHub Actions example
name: Update Arc Memory Graph

on:
  push:
    branches: [main]

jobs:
  update-graph:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.10'
      - name: Install Arc Memory
        run: pip install arc-memory
      - name: Update graph
        run: arc build --incremental
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Add Arc Memory to your CI/CD pipeline to keep your knowledge graph up-to-date:

# GitHub Actions example
name: Update Arc Memory Graph

on:
  push:
    branches: [main]

jobs:
  update-graph:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0
      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: '3.10'
      - name: Install Arc Memory
        run: pip install arc-memory
      - name: Update graph
        run: arc build --incremental
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Use Arc Memory in your Python code:

from arc_memory import ArcMemory

# Initialize Arc Memory
arc = ArcMemory()

# Build the knowledge graph
arc.build()

# Trace history for a file
history = arc.trace_file("path/to/file.py", line_number=42)

# Process the results
for item in history:
    print(f"Commit: {item.commit_hash}")
    print(f"Author: {item.author}")
    print(f"Date: {item.date}")
    print(f"Message: {item.message}")

Getting Started

CLI Commands

API Documentation

Usage Examples

Guides

Architecture Decision Records

Features

Benchmarks

Quick start

Quick Start Guide

5-Minute Quick Start

Complete Example

What’s Next?

CLI Reference

API Reference

Usage Examples

Getting Started

CLI Commands

API Documentation

Usage Examples

Guides

Architecture Decision Records

Features

Benchmarks

​Quick Start Guide

​5-Minute Quick Start

​Complete Example

​What’s Next?

CLI Reference

API Reference

Usage Examples

Quick Start Guide

5-Minute Quick Start

Complete Example

What’s Next?