Quick Start Guide

This guide will help you get started with CommitKey quickly. We'll walk you through setting up your first repository and making your first commit via API.

Prerequisites

• A CommitKey account (sign up at commitkey.dev)
• Your API key (found in your account settings)
• Basic familiarity with Git concepts

Step 1: Get Your API Key

1. Sign up for a CommitKey account
2. Navigate to your account settings
3. Generate a new API key
4. Copy the key - you'll need it for API requests

Step 2: Create Your First Repository

Use our API to create a new repository:

curl -X POST https://api.commitkey.dev/v1/repositories \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "my-first-repo",
    "description": "My first CommitKey repository",
    "private": true
  }'

Step 3: Make Your First Commit

Create a file and commit it:

# Create a file
curl -X POST https://api.commitkey.dev/v1/repositories/my-first-repo/files \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "path": "README.md",
    "content": "# My First Repository\n\nThis is my first repository created with CommitKey!",
    "message": "Add README file",
    "author": {
      "name": "Your Name",
      "email": "your.email@example.com"
    }
  }'

Step 4: Verify Your Repository

Check that your repository was created and the file was committed:

curl -X GET https://api.commitkey.dev/v1/repositories/my-first-repo \
  -H "Authorization: Bearer YOUR_API_KEY"

Next Steps

Now that you have a basic repository set up, explore these resources:

• API Reference - Complete API documentation
• Authentication - Learn about API authentication
• Repository Management - Advanced repository operations
• AI Agent Integration - Integrate with AI agents

Need Help?

• Check our FAQ
• Join our Discord community
• Contact support at support@commitkey.dev