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

# Introduction

> Install and get started with the Royaltyport command-line interface.

The Royaltyport CLI (`@royaltyport/cli`) lets you authenticate, browse projects, and interact with project sandboxes from the terminal. It is designed for both manual use and integration with AI agents and CI/CD pipelines.

## Requirements

* **Node.js** >= 18.0.0

## Installation

### npm (recommended)

```bash theme={null}
npm install -g @royaltyport/cli
```

### From source

```bash theme={null}
git clone https://github.com/royaltyport/cli.git
cd cli
npm install
npm link
```

After installation, the `royaltyport` command is available globally.

***

## Quick Start

<Steps>
  <Step title="Log in">
    Authenticate with your API token:

    ```bash theme={null}
    royaltyport login
    ```

    You will be prompted for your token (`rp_...`). See [Authentication](/cli-reference/authentication) for all login methods.
  </Step>

  <Step title="List projects">
    View all projects accessible to your token:

    ```bash theme={null}
    royaltyport projects
    ```
  </Step>

  <Step title="Explore a project">
    Display the project's sandbox overview:

    ```bash theme={null}
    royaltyport project info <project_id>
    ```
  </Step>

  <Step title="Run a command">
    Execute a bash command in the project sandbox:

    ```bash theme={null}
    royaltyport project exec <project_id> "ls contracts/"
    ```
  </Step>
</Steps>

***

## Configuration

Credentials and settings are stored at:

```
~/.config/royaltyport/config.json
```

This file is managed automatically by the CLI using [conf](https://github.com/sindresorhus/conf). Running `royaltyport logout` clears it.

***

## Agent Skill

The CLI includes a [skills.sh](https://skills.sh/)-compatible agent skill that teaches AI agents how to use the CLI to explore and query Royaltyport project data.

Install it into your agent:

```bash theme={null}
npx skills add royaltyport/cli
```

The skill covers authentication, project discovery, filesystem layout, and common data access patterns.

***

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/cli-reference/authentication">
    Login methods, environment variables, and configuration.
  </Card>

  <Card title="Commands" icon="terminal" href="/cli-reference/commands">
    Full reference for all CLI commands.
  </Card>
</CardGroup>