Skip to content

Rool CLI

v0.3.12

Command-line interface for the Rool platform.

Installation

Terminal window
npm install -g @rool-dev/cli

Usage

Terminal window
rool <command> [options]

Commands

CommandDescription
chat [prompt]Chat with a space (interactive if no prompt)
media upload <file>Upload a file to a space and create an object with the media URL
space listList all spaces
space create <name>Create a new space
space delete <name>Delete a space
extension create [name]Create a new Rool extension
extension devStart the dev server
extension buildBuild the extension
extension publishBuild and publish the extension
extension listList published extensions
extension unpublish <extension-id>Unpublish an extension
userShow current user info
logoutLog out

Global Options

OptionDescription
-V, --versionShow version number
-h, --helpShow help for any command

Command Options

OptionDescriptionDefaultUsed by
-s, --space <name>space nameRool CLIchat, media upload
-c, --channel <id>channel IDrool-devchat
-m, --message <text>optional comment/descriptionmedia upload
-y, --yesskip confirmation promptspace delete

Examples

Terminal window
# Chat with the default space
rool chat "What is the capital of France?"
# Interactive chat mode
rool chat
# Use a specific space
rool chat -s "My Project" "Summarize the current state"
# Upload a file
rool media upload photo.jpg
# Upload with a comment
rool media upload report.pdf -m "Q4 sales report"
# Upload to a specific space
rool media upload logo.png -s "My Project"
# List your spaces
rool space list
# Create a new space
rool space create "My New Project"
# Delete a space (with confirmation)
rool space delete "Old Project"
# Delete without confirmation
rool space delete "Old Project" -y
# Show user info
rool user
# Log out
rool logout

Authentication

On first use, the CLI opens your browser to authenticate. Credentials are stored in ~/.config/rool/.

License

MIT - see LICENSE for details.