No history yet

OpenCode CLI Setup

Setting Up the OpenCode CLI

OpenCode is a terminal-native AI coding assistant that transforms natural language instructions into code, automates workflows, and orchestrates complex development tasks. It acts as an agentic layer directly within your command-line interface, integrating with various AI providers to streamline your development process. This setup is the first step in leveraging its capabilities for agentic software development.

OpenCode is an AI agent for coding that runs directly in the terminal.

Installation

The OpenCode CLI is distributed as an npm package, allowing for straightforward installation using your preferred JavaScript package manager. Choose the command that corresponds to your environment.

# Using npm
npm install -g opencode

# Using Yarn
yarn global add opencode

# Using pnpm
pnpm add -g opencode

Configuration

After installation, you must configure OpenCode to connect with an AI provider. This involves setting the provider's name and providing an API key. OpenCode stores this configuration locally in a ~/.opencode/.env file. For this example, we'll configure it to use the ohmygpt provider, which is compatible with any OpenAI-compliant API.

# Set the provider
opencode config set provider ohmygpt

# Set the API key (replace YOUR_API_KEY with your actual key)
opencode config set api_key YOUR_API_KEY

Your API key is stored locally and is never transmitted to any servers other than the specified provider's API endpoint. Ensure the ~/.opencode/ directory has appropriate permissions.

Verification

Once installation and configuration are complete, verify that the OpenCode CLI is working correctly. You can check the installed version and run a diagnostic check to ensure all components are properly configured and communicating.

# Check the installed version
opencode --version

# Run the diagnostic tool
opencode doctor

The opencode doctor command checks your configuration, verifies the API key, and attempts a test connection to the provider's API. A successful output from this command confirms that your setup is complete and ready for use.

Quiz Questions 1/4

What is the primary function of OpenCode?

Quiz Questions 2/4

How is the OpenCode CLI typically installed?

With the CLI installed and configured, you are now prepared to use OpenCode for various agentic development tasks.