Skip to main content
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 install -g @royaltyport/cli

​
From source

git clone https://github.com/royaltyport/cli.git
cd cli
npm install
npm link
After installation, the royaltyport command is available globally.

​
Quick Start

1

Log in

Authenticate with your API token:
royaltyport login
You will be prompted for your token (rp_...). See Authentication for all login methods.
2

List projects

View all projects accessible to your token:
royaltyport projects
3

Explore a project

Display the project’s sandbox overview:
royaltyport project info <project_id>
4

Run a command

Execute a bash command in the project sandbox:
royaltyport project exec <project_id> "ls contracts/"

​
Configuration

Credentials and settings are stored at: 
~/.config/royaltyport/config.json
This file is managed automatically by the CLI using conf. Running royaltyport logout clears it.

​
Agent Skill

The CLI includes a 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: 
npx skills add royaltyport/cli
The skill covers authentication, project discovery, filesystem layout, and common data access patterns.

Authentication

Login methods, environment variables, and configuration.

Commands

Full reference for all CLI commands.