mcpField
L
ludus-cli

ludus-cli

github.com/badsectorlabsSecurity1090 installsUpdated 22w ago
Repository

About ludus-cli

ludus-cli is a reference skill for Ludus command syntax, flags, and workflows, for users running commands directly or working without the Ludus API. It covers setup, range deployment, testing mode, and template management.

Key features

  1. 01Reference command syntax and flags
  2. 02Explain global options and environment variables
  3. 03Guide range deployment and status checks
  4. 04Describe testing mode workflows
  5. 05Cover template management commands

Use cases

  1. 01Deploy a Ludus range from the command line
  2. 02Review deployment logs and status
  3. 03Use testing mode and manage allowed domains
  4. 04Add and build templates

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/badsectorlabs/ludus-skills --skill ludus-cli

After installing, type/ludus-cliin Claude Code to confirm it loaded.

Bundled filesagents/openai.yamlreferences/commands.md

Details

From the project README

Ludus CLI Reference

Reference for Ludus CLI command syntax, flags, and workflows. Use this when users need to run CLI commands directly or when the Ludus API is unavailable.

Key Concepts

Command Pattern
ludus COMMAND [SUBCOMMAND] [ARGS] [--FLAGS]
Global Flags (Available on All Commands)
  • --json - Format output as JSON
  • --url string - Server URL (default: https://198.51.100.1:8080)
  • -u, --user string - Impersonate user (admin only)
  • -r, --range string - Target range ID
  • --proxy string - HTTP(S) proxy URL
  • --verbose - Verbose output
  • --verify - Verify HTTPS certificate

All flags can be set via environment variables: LUDUS_FLAG_NAME (uppercase).

Common Workflows

Initial Setup:

ludus apikey                    # Store API key
ludus templates list            # Check available templates
ludus range config get example  # Get example config

Deploy a Range:

ludus range config set -f config.yml  # Set config
ludus range deploy                     # Full deploy
ludus range logs -f                    # Watch progress
ludus range status                     # Check status

Testing Mode:

ludus testing start                      # Snapshot + block internet
ludus testing allow -d example.com       # Allow a domain
ludus testing stop                       # Revert snapshots + restore internet

Template Management:

ludus templates add -d ./my-template   # Add template
ludus templates build                   # Build all unbuilt
ludus templates build -n name1,name2   # Build specific
ludus templates logs -f                 # Watch build progress

References

  • Use references/commands.md for the complete command reference with subcommands, flags, and examples.
  • Use https://docs.ludus.cloud/docs/cli as the authoritative source for CLI behavior and changes.

Comments

Markdown supported