Home / Quick Start

Quick Start Guide

Get up and running with CodeAnvil in 5 minutes.

Beginner 5 minutes

Prerequisites

Before you start, make sure you have:

Git installed on your system
Rust and Cargo for building from source
An SSH key (ed25519 recommended)

💡 SSH Key Setup

If you don't have an SSH key, generate one:

bash

ssh-keygen -t ed25519 -C "your-email@example.com"

1. Install the CLI

Choose one of the following installation methods:

⚠️ Prerequisite: Rust

CodeAnvil is distributed as source code. You need Rust installed to build it:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Option A: Download Source Tarball (Recommended)

Download the source tarball and build it:

bash

# Download the latest CLI source tarball
curl -sSL https://codeanvil.io/downloads/anvil-latest.tar.gz -o anvil.tar.gz

# Extract
tar -xzf anvil.tar.gz
cd anvil-*

# Build with Cargo
cargo build --release

# Install to /usr/local/bin
sudo cp target/release/anvil /usr/local/bin/

The tarball includes a README.md with complete installation instructions.

Option B: Download a Specific Version

Download a specific version from the downloads page:

bash

# Download specific version (e.g., 0.1.0)
curl -sSL https://codeanvil.io/downloads/anvil-0.1.0.tar.gz -o anvil.tar.gz

# Extract and build
tar -xzf anvil.tar.gz
cd anvil-*
cargo build --release
sudo cp target/release/anvil /usr/local/bin/

Option C: Clone and Build from Source

If you have access to the repository:

bash

# Clone from codeanvil.io (after registering)
git clone git@codeanvil.io:anvil.git
cd anvil

# Build and install
cargo build --release
sudo cp target/release/anvil /usr/local/bin/

Verify the installation:

bash

anvil --version

2. Register Your Account

Create your CodeAnvil account using your SSH key for authentication:

bash

# Register with your email
anvil register your-email@example.com

⚠️ SSH Agent Required

Make sure your SSH agent is running and your key is loaded:

bash

# Start SSH agent (if not running)
eval $(ssh-agent -s)

# Add your key
ssh-add ~/.ssh/id_ed25519

3. Setup Your Repository

Create a new example repository to get started:

bash

# Create a new project directory
mkdir ~/anvil-example && cd ~/anvil-example

# Initialize git
git init

# Create a sample file
echo "# My First CodeAnvil Project" > README.md
git add README.md
git commit -m "Initial commit"

# Setup the repository on CodeAnvil
anvil repo setup

# Push your code
git push -u origin main

The repo setup command:

Creates the repository on CodeAnvil
Sets the origin remote automatically
Uses your current directory name as the repo name

4. Create a Pull Request

Create a feature branch and open a pull request:

bash

# Create a feature branch
git checkout -b feature/my-feature

# Make changes and commit
echo "Hello CodeAnvil" > hello.txt
git add hello.txt
git commit -m "Add hello file"
git push -u origin feature/my-feature

# Create the pull request
anvil pr create

Note the commit hash from the output — you'll use it for all PR operations:

bash

# Check PR status
anvil pr status 

# Approve the PR (as a reviewer)
anvil pr approve 

# Merge the PR
anvil pr merge

Next Steps

Now that you're set up, explore these guides:

🔄 Workflow Guide

Learn the complete PR workflow with reviews and merging.

Recommended

🛡️ Branch Protection

Enforce review requirements and build checks.

🤖 Build Agents

Set up CI/CD on your own infrastructure.

⌨️ CLI Reference

All commands and options at a glance.