CLI Command Reference

Rimuru's CLI is the primary interface for interacting with the agent ecosystem. Every command follows the pattern: rimuru <command> [options]

Global Flags

--help, -h        Show help
--version, -v     Show version
--config, -c      Path to config file
--verbose, -V     Enable verbose output
--no-color        Disable colored output
--json            Output as JSON

Core Commands

rimuru init

Initialize a new Rimuru project in the current directory.

rimuru init rimuru init --template minimal rimuru init --template full --name my-project

rimuru run <workflow>

Execute a workflow definition.

rimuru run workflow.yaml rimuru run workflow.yaml --watch   # Watch mode rimuru run workflow.yaml --dry-run # Preview without executing rimuru run .                       # Run default workflow

Options: --agent <name>, --param <key=value>, --timeout <ms>, --parallel

rimuru agent <command>

Manage the agent fleet.

rimuru agent list                  # List all available agents rimuru agent info <name>           # Show agent details rimuru agent spawn <name>          # Spawn a new agent instance rimuru agent kill <name>           # Terminate an agent rimuru agent logs <name>           # View agent logs

rimuru web

Launch the Rimuru web dashboard.

rimuru web                         # Start on default port (3456) rimuru web --port 8080             # Custom port rimuru web --host 0.0.0.0          # Listen on all interfaces rimuru web --open                  # Open browser automatically

rimuru mcp <command>

Manage MCP (Model Context Protocol) servers.

rimuru mcp list                    # List connected MCP servers rimuru mcp add <name> <command>    # Add a new MCP server rimuru mcp remove <name>           # Remove an MCP server rimuru mcp inspect <name>          # Inspect server tools/resources

rimuru plugin <command>

Manage plugins.

rimuru plugin list                 # List installed plugins rimuru plugin install <name>       # Install a plugin rimuru plugin remove <name>        # Remove a plugin rimuru plugin create <name>        # Scaffold a new plugin

rimuru memory

Manage the memory system.

rimuru memory status               # Show memory usage rimuru memory clear                # Clear working memory rimuru memory export               # Export semantic memory rimuru memory import <file>        # Import memory

rimuru config

Manage configuration.

rimuru config get <key>            # Get a config value rimuru config set <key> <value>    # Set a config value rimuru config list                 # List all configuration rimuru config validate             # Validate config file rimuru config edit                 # Open config in editor

rimuru skill <command>

Manage skills (reusable workflow templates).

rimuru skill list                  # List available skills rimuru skill install <name>        # Install a skill rimuru skill create <name>         # Create a new skill rimuru skill search <query>        # Search for skills

rimuru completion <shell>

Generate shell completion scripts.

rimuru completion bash rimuru completion zsh rimuru completion fish

rimuru update

Update Rimuru to the latest version.

rimuru update                      # Check and update rimuru update --beta               # Include beta releases rimuru update --version 1.2.0      # Specific version

rimuru status

Show system status and information.

rimuru status                      # System status overview rimuru status --verbose            # Detailed status

Exit Codes