Getting Started¶
Welcome to Ringlet! This section will help you get up and running quickly.
Overview¶
Ringlet helps you manage multiple AI coding agents with different configurations. Here's what you'll learn:
- Installation - Install Ringlet on your system
- Quick Start - Create and run your first profile
- Key Concepts - Understand how Ringlet works
Prerequisites¶
Before installing Ringlet, ensure you have:
- An AI coding agent installed (Claude Code, Codex CLI, etc.)
- An API key from your provider (Anthropic, OpenAI, etc.)
- Linux or macOS (Windows support coming soon)
5-Minute Setup¶
If you want to dive right in:
# 1. Install Ringlet
curl -fsSL https://raw.githubusercontent.com/neul-labs/ringlet/main/install.sh | bash
# 2. Create a profile
ringlet profiles create claude my-project --provider anthropic
# 3. Run it
ringlet profiles run my-project
That's it! Your agent will start with its own isolated configuration.
What's Next?¶
-
:material-download:{ .lg .middle } Installation
Detailed installation instructions for all platforms and methods.
-
:material-rocket-launch:{ .lg .middle } Quick Start
Step-by-step tutorial to create your first profile.
-
:material-lightbulb:{ .lg .middle } Key Concepts
Understand agents, providers, profiles, and how they work together.