Skip to main content
Version: 0.1.0

CLI Commands

Complete command reference for the RaisinDB CLI.

Authentication

login

Authenticate with a RaisinDB server. Opens your browser for login, then saves the token to .raisinrc. All subsequent commands use this authentication.

raisindb login
raisindb login --server https://my-server.example.com
OptionDescription
-s, --server <url>Server URL (default: http://localhost:8080 or from .raisinrc)

logout

Clear the stored authentication token.

raisindb logout

Server Management

server install

Download and install the RaisinDB server binary for your platform.

raisindb server install
raisindb server install --version v0.1.3
OptionDescription
-v, --version <tag>Install a specific version
-f, --forceForce reinstall

server start

Start the RaisinDB server. On first run, downloads the binary automatically.

raisindb server start
raisindb server start --port 9090 --detach
OptionDescription
--port <port>HTTP port (default: 8080)
--pgwire-port <port>PostgreSQL protocol port (default: 5432)
--config <path>Path to config file
--productionProduction mode
--verboseShow server logs in terminal
-d, --detachRun in background

On first start, admin credentials are printed to the terminal.

server stop

Stop a running RaisinDB server.

raisindb server stop

server status

Check server health and status.

raisindb server status

server logs

View server logs.

raisindb server logs
raisindb server logs -f -n 100
OptionDescription
-f, --followStream logs in real-time
-n, --lines <count>Number of lines to show (default: 50)

server update

Update the server binary to the latest version.

raisindb server update

server version

Show the installed server version.

raisindb server version

Package Management

package init

Scaffold a new RaisinDB project with package structure, frontend placeholder, and AI agent skills.

raisindb package init my-app
raisindb package init my-app --name "My App" --workspace content

This automatically:

  1. Creates the project structure (package/, frontend/, package.json, etc.)
  2. Runs npm install (installs @raisindb/functions-types)
  3. Installs AI agent skills via npx skills add
OptionDescription
--pack <name>Template pack (default: minimal)
-n, --name <name>Package name (default: folder name)
-w, --workspace <name>Workspace name (default: package name)
-d, --description <text>Package description
--skip-installSkip npm install and skills installation

package create

Create a .rap package file from a folder.

raisindb package create ./package
raisindb package create ./package --check
raisindb package create ./package -o custom-name.rap
OptionDescription
-o, --output <file>Output file path
--checkValidate only (don't create package)
--no-validateSkip validation

package deploy

Validate, build, and upload a package in one step. Reads manifest.yaml for the name and version automatically.

raisindb package deploy ./package
raisindb package deploy ./package --repo demo
OptionDescription
-s, --server <url>Server URL
-r, --repo <name>Repository name

package upload

Upload a .rap package to the server.

raisindb package upload my-app-0.1.0.rap --repo demo
OptionDescription
-s, --server <url>Server URL
-r, --repo <name>Repository name
-p, --path <path>Target path in repository

package list

List packages in a repository.

raisindb package list --repo demo
OptionDescription
-s, --server <url>Server URL
-r, --repo <name>Repository name

package install

Install a package by name.

raisindb package install my-package --repo demo
OptionDescription
-s, --server <url>Server URL
-r, --repo <name>Repository name

package sync

Synchronize a local package directory with the server. Supports watch mode for live development.

raisindb package sync ./package --watch
raisindb package sync ./package --push
OptionDescription
-w, --watchWatch mode (continuous sync)
-p, --pushOne-way: local to server only
-l, --pullOne-way: server to local only
-y, --yesSkip confirmations
-f, --forceOverwrite conflicts
-n, --dry-runShow changes without applying
-r, --repo <name>Repository name
-s, --server <url>Server URL
--initInitialize sync configuration

package clone

Clone a package from the server to a local directory.

raisindb package clone my-package
raisindb package clone my-package -o ./local-dir
OptionDescription
-o, --output <dir>Output directory
-s, --server <url>Server URL
-r, --repo <name>Repository name
-b, --branch <name>Branch name (default: main)

package create-from-server

Interactive: create a new package by selecting content from the server.

raisindb package create-from-server --repo demo
OptionDescription
-s, --server <url>Server URL
-r, --repo <name>Repository name

Interactive Shell

shell

Start an interactive SQL shell with syntax highlighting and auto-completion.

raisindb shell
raisindb shell --server http://remote:8080 --database demo
OptionDescription
-s, --server <url>Server URL
-d, --database <name>Database/repository to use

Shell commands (inside the shell):

  • /connect <url> — Connect to a server
  • /login — Authenticate via browser
  • /logout — Clear authentication
  • use <database> — Switch database
  • /databases — List databases
  • /sql — Enter SQL mode
  • /help — Show help
  • /quit — Exit