Documentation

Search documentation

Quickstart

Install Orek, activate your license, connect a model provider, and ask your first project question.

Install Orek, activate a license, connect a model provider, and ask your first question. Model usage is billed separately from your Orek license.

1. Install Orek

Run the installer for your platform. It verifies the download’s size and SHA-256 digest, then installs orek and its bundled runtime for local models in your user directory without administrative rights.

Windows (PowerShell):

In your shell

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

macOS and Linux:

In your shell

curl -fsSL https://orek.ai/install.sh | sh

Verify that orek is on your PATH:

In your shell

orek --version

For manual archives, scripted deployment, or operating-system download warnings, see Installation & updates.

2. Activate your license

Approve this device in your browser to start a 14-day trial or use a paid license:

In your shell

orek license login

To activate online with a paid license key instead, run:

In your shell

orek license activate

Check your license at any time, even offline:

In your shell

orek license status

To activate a machine without internet access, or for other options, see Activate your license.

3. Open your project and run setup

Open a shell in your project folder and launch Orek:

In your shell

orek

When Orek starts without a configured provider, the setup wizard opens automatically. You can also open it from the composer:

In Orek · command

/setup

Select a provider, enter its API key in the private credential field, review the default model and theme, and save. Provider credentials are separate from your Orek license and stay on your machine in the operating system credential store or environment variables.

To add another provider or rotate a key later without changing your pinned model or theme, use /setup provider. For service-specific options and the built-in catalog, see Providers. To run a local model instead, see Local models.

4. Ask your first question

Optionally open /model to choose a different configured model. Then type a project question in the composer and press Enter:

In Orek · prompt

Read the README and explain how to run this project.

Watch the response and any tool cards. Read each command or edit approval carefully before confirming it; Using Orek explains the composer, approvals, and result panes.

If the provider request fails, run /doctor and /log inside Orek, or run orek providers check in your shell. See Troubleshooting & diagnostics for common investigations.

Optional: index your project

You can chat without an index. Build one when you want symbol navigation and code search:

In Orek · command

/index build

When the build finishes, check its status:

In Orek · command

/index status

Default embeddings run locally without an external account or runtime downloads, on your GPU when Orek finds a compatible one and on the CPU otherwise. Cloud embeddings are optional. See Find and explore code for indexing, retrieval, and embedding choices.

A lightweight cloud-only setup can keep indexing, automatic retrieval, and local models disabled; use the minimum profile settings.

Next steps