# Getting Started

Install OrchaJS in an existing Node.js app or create a new project with create-orcha.

Source: https://orcha.sh/docs
Markdown: https://orcha.sh/docs.mdx

## Prerequisites

Requires Node.js 20.12 or newer and an API key for the model provider of your choice.

## Add Orcha to an existing project

```bash
npm install orchajs
npx orcha init
```

Running `orcha init` in the current directory:

- Creates `orcha/exampleAgent/index.json`
- Creates `orcha/exampleAgent/instructions.md`
- Creates `orcha/index.ts` with Anthropic configured and `exampleAgent` registered
- Creates root-level `AGENTS.md` with the complete Orcha development guide
- Adds `.orcha/` to `.gitignore`

Existing files are skipped, not overwritten.

## Add Orcha as a skill

Give your coding agent the complete Orcha development guide:

```bash
npx skills add Amarsia/orcha
```

## Create a new Node.js project

```bash
npx create-orcha@latest my-app-name
cd my-app-name
npm install
cp .env.example .env
```

The starter includes example agents and scripts for the local development playground, tests, and production compilation.

## Add your provider credentials

Create a root-level `.env` file and add the credentials for the provider configured in `orcha/index.ts`.

### Anthropic

```bash
ANTHROPIC_API_KEY=your-anthropic-key
```

### OpenAI

```bash
OPENAI_API_KEY=your-openai-key
```

### DeepSeek

```bash
DEEPSEEK_API_KEY=your-deepseek-key
```

### Google Gemini

```bash
GOOGLE_API_KEY=your-google-ai-key
```

The provider name in agent configuration is `googlegenai`.

### Google Vertex AI

```bash
GOOGLE_CLOUD_PROJECT=your-project-id
GOOGLE_CLOUD_LOCATION=us-central1
GOOGLE_APPLICATION_CREDENTIALS=/absolute/path/to/service-account.json
```

Vertex AI can also use Application Default Credentials without
`GOOGLE_APPLICATION_CREDENTIALS`.

### Amazon Bedrock

```bash
AWS_REGION=us-east-1
AWS_ACCESS_KEY_ID=your-access-key-id
AWS_SECRET_ACCESS_KEY=your-secret-access-key
AWS_SESSION_TOKEN=your-session-token
```

Bedrock uses the normal AWS credential chain when explicit credentials are
omitted.

[Read more about model providers →](/docs/model-providers)