Documentation Guide
Welcome to the Arc Memory SDK documentation. This guide will help you navigate our documentation to find the information you need quickly and efficiently.
Beta Release: Arc Memory SDK is currently in beta. We’re actively gathering feedback and improving the platform.
How to Use This Documentation
If you’re new to Arc Memory, we recommend following this path:
1
Read the Introduction
Start with the home page to understand what Arc Memory is and its key features.
2
Install Arc Memory
Follow the installation guide to set up Arc Memory on your system.
3
Try the Quick Start
Use the quick start guide to build your first knowledge graph.
4
Explore Examples
Check out the examples to see real-world usage scenarios.
Documentation Map
Documentation Structure
Documentation Structure
Main Documentation Sections
Getting Started
Begin your journey with Arc Memory:
CLI Reference
Command-line interface documentation:
API Reference
Programmatic interfaces:
Examples
Real-world usage examples:
Architecture & Design
Common Use Cases
1
Understand code history
Use
arc trace file to understand the history and context of specific code:2
Find related PRs and issues
Discover the PRs and issues related to specific code changes.
3
Track architectural decisions
Connect code changes to architectural decisions documented in ADRs.