About

@orionhosting/cli is the official Orion Hosting command line interface (CLI) to manage your server from your local terminal. After linking a directory to your server, you can run orion deploy to push and restart your Orion's server.

Read the CLI documentation here.

Installation

Node.js 23 or newer is required.

npm install -g @orionhosting/cli

Usage

Global commands

# Help commands
orion --help
orion --version
orion help [command]

# Login to your account
orion login

# Logout from your account
orion logout

# View which account you are logged in
orion account

# List your servers
orion list

# Open the documentation website
orion docs

# Manage telemetry
orion telemetry status
orion telemetry enable
orion telemetry disable

Project commands

Be sure to be in your project's folder before running this.

# Link the current directory to your server
orion link

# Get the status of the linked server
orion status

# Deploy the local project to the linked server
orion deploy

# Start your server
orion start

# Start or restart your server
orion restart

# Stop your server
orion stop

# Open your server's panel
orion open

# Open the console inside your terminal
orion console

Global options

All commands accepts both --token <TOKEN> and --server <SERVER_ID> options which let you use the CLI without the need to run orion login and orion link.

These options are made to be used inside CI/CD workflows like GitHub Actions, to e.g. automatically deploy your project on push.

Links

• Orion Discord
• GitHub
• npm
• Voctal
• Octara

Help

Need help with the CLI? Ask on our support server!