Installation & Getting Started

This guide will help you complete the installation and initial setup of Carry Code.

---

System Requirements

Operating System	Supported Architectures
macOS	ARM64 (Apple Silicon), x64 (Intel)
Linux	x64, ARM64, musl
Windows	x64 (PowerShell)

---

One-Line Installation

macOS / Linux

Open your terminal and copy-paste the following command:

curl -fsSL https://carrycode.ai/install.sh | sudo sh

Windows

Open PowerShell (right-click Start menu → Windows PowerShell) and copy-paste:

irm https://carrycode.ai/install.ps1 | iex

The installation script will automatically:

1. Detect your operating system and architecture
2. Download the corresponding binary
3. Verify file integrity
4. Install to /usr/local/bin (Linux/macOS) or current directory (Windows)

---

Verify Installation

After installation, run this command in your terminal:

carry --help

If you see the help information, the installation was successful!

Carry Code - Your AI Coding Agent

Usage:
  carry [options]           Start interactive mode
  carry --once "prompt"    Single execution mode
  carry --help             Show help information

---

First Launch

Start Carry Code

Run this command in your terminal:

carry

Setup Wizard

On first launch, a setup wizard will guide you through:

1. Select Language - Choose “中文” or “English”
2. Select Theme - Light or dark theme
3. Configure AI Model - Choose a provider and enter your API Key

---

What is an API Key?

An API key is like a key that allows you to use AI services. Most providers offer free trial credits.

Recommended AI Providers

Provider	Features	Why Recommended
DeepSeek	High cost-performance	Direct access from China, affordable
OpenAI	GPT series	Comprehensive capabilities, industry-leading
Anthropic	Claude series	Strong programming capabilities
Alibaba Cloud	Tongyi Qianwen	Stable, reliable domestic service

How to Get an API Key?

DeepSeek (Recommended for China users):

1. Visit https://platform.deepseek.com
2. Register an account
3. Go to “API Keys” page
4. Click “Create API Key”
5. Copy the key

OpenAI:

1. Visit https://platform.openai.com
2. Register and log in
3. Go to “API Keys” page
4. Create a new key

Other providers: Similar process - register and find “API Keys” in settings.

---

VSCode Plugin (Optional)

If you use VSCode, you can also install the Carry Code plugin for a better experience:

1. Open VSCode
2. Click “Extensions” in the sidebar
3. Search for “carrycode”
4. Click Install

VSCode Plugin Store Link

---

Troubleshooting

Q: Installation failed?

Solutions:

1. Check network connection
2. Confirm your system is supported
3. Try manual download: visit https://carrycode.ai/releases

Q: Permission denied?

Solutions:

# Linux/macOS
sudo sh install.sh

# Windows
Run PowerShell as administrator

Q: How to update to the latest version?

In Carry Code, enter:

/update

Or run the installation script again:

curl -fsSL https://carrycode.ai/install.sh | sudo sh

---

Next Steps

• Quick Start - Start your first conversation
• Basic Usage - Learn common use cases