> ## Documentation Index
> Fetch the complete documentation index at: https://docs.remyx.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Install the CLI

> Install the Remyx CLI, configure an API key, and verify the commands.

Use the Remyx CLI to set up Outrider and access supported research and repository commands from your terminal.

## Requirements

* Python 3 and `pip`
* A Remyx API key from [Studio → Account → API keys](https://studio.remyx.ai/account?tab=keys)

## Install

```bash theme={null}
python -m pip install remyxai
remyxai --help
```

## Authenticate

Set your key in the same shell session where you run the CLI. See [Authenticate](https://docs.remyx.ai/cli/authenticate.md) for macOS, Linux, and PowerShell examples.

```bash theme={null}
export REMYXAI_API_KEY="YOUR_REMYX_API_KEY"
```

Keep your key out of committed files and terminal logs. Use the secret store appropriate for your environment.

## Troubleshooting

> [accordion] REMYXAI\_API\_KEY is missing or invalid
>
> Check whether the variable is set without printing its value:
>
> ```bash theme={null}
> if [ -n "${REMYXAI_API_KEY:-}" ]; then
>   echo "API key is set"
> else
>   echo "API key is missing"
> fi
> ```
>
> If it is missing, export the key in the shell running `remyxai`. If authentication fails, check the key and its [scopes](https://docs.remyx.ai/api-reference/scopes.md) in Studio.

> [accordion] Command not found: remyxai
>
> Verify the package is installed in your active Python environment:
>
> ```bash theme={null}
> python -m pip show remyxai
> ```
>
> Use the same Python environment for installation and execution. Ensure its scripts directory is on your `PATH`. Avoid using `sudo pip install` to solve a user environment issue.

## Next steps

[Set up a repository](https://docs.remyx.ai/cli/outrider-setup.md) · [CLI command reference](https://docs.remyx.ai/api-reference/cli-reference.md) · [Quickstart](https://docs.remyx.ai/quickstart.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.