Package Exports
- @rool-dev/cli
- @rool-dev/cli/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rool-dev/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Rool CLI
Command-line interface for the Rool platform.
Installation
npm install -g @rool-dev/cliUsage
rool <command> [options]Commands
| Command | Description |
|---|---|
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 list |
List all spaces |
space create <name> |
Create a new space |
space delete <name> |
Delete a space |
app publish <app-id> <path> |
Publish a directory as an app |
app list |
List published apps |
app unpublish <app-id> |
Unpublish an app |
app slug [new-slug] |
Show or set your user slug |
user |
Show current user info |
logout |
Log out |
create [name] |
Create a new Rool app |
Global Options
| Option | Description |
|---|---|
-V, --version |
Show version number |
-h, --help |
Show help for any command |
Command Options
| Option | Description | Default | Used by |
|---|---|---|---|
-s, --space <name> |
space name | Rool CLI |
chat, media upload |
-c, --channel <id> |
channel ID | rool-dev |
chat |
-m, --message <text> |
optional comment/description | media upload |
|
-y, --yes |
skip confirmation prompt | space delete |
|
-n, --name <name> |
app display name (defaults to app-id) | app publish |
|
--no-spa |
disable SPA routing (404s will not serve index.html) | app publish |
Examples
# 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
# Publish a directory as an app
rool app publish my-app ./dist
# Publish with a custom name
rool app publish my-app ./dist -n "My App"
# List published apps
rool app list
# Unpublish an app
rool app unpublish my-app
# Show your user slug
rool app slug
# Set your user slug
rool app slug my-slug
# Show user info
rool user
# Log out
rool logoutAuthentication
On first use, the CLI opens your browser to authenticate. Credentials are stored in ~/.config/rool/.
License
MIT - see LICENSE for details.