https://github.com/dreadnode/robopages-cli
CLI and API server for https://github.com/dreadnode/robopages
https://github.com/dreadnode/robopages-cli
Last synced: 5 months ago
JSON representation
CLI and API server for https://github.com/dreadnode/robopages
- Host: GitHub
- URL: https://github.com/dreadnode/robopages-cli
- Owner: dreadnode
- License: mit
- Created: 2024-10-12T16:59:54.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-08-20T00:28:58.000Z (5 months ago)
- Last Synced: 2025-08-20T02:33:51.706Z (5 months ago)
- Language: Rust
- Homepage:
- Size: 445 KB
- Stars: 34
- Watchers: 6
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-rainmana - dreadnode/robopages-cli - CLI and API server for https://github.com/dreadnode/robopages (Rust)
README
# Robopages Server
**CLI and API server for [robopages](https://github.com/dreadnode/robopages)**
# Table of Contents
- [Robopages Server](#robopages-server)
- [CLI and API server for robopages](#cli-and-api-server-for-robopages)
- [Table of Contents](#table-of-contents)
- [Install with Cargo](#install-with-cargo)
- [Pull from Docker Hub](#pull-from-docker-hub)
- [Build Docker image](#build-docker-image)
- [Note about Docker](#note-about-docker)
- [Build from source](#build-from-source)
- [Usage](#usage)
- [CLI](#cli)
- [SSH](#ssh)
- [Using with LLMs](#using-with-llms)
- [Docker Container Failures](#docker-container-failures)
[Robopages are YAML based files](https://github.com/dreadnode/robopages) for describing tools to large language models (LLMs). They simplify the process of defining and using external tools in LLM-powered applications. By leveraging the `robopages-cli` function calling server, developers can avoid the tedious task of manually writing JSON declarations for each tool. This approach streamlines tool integration, improves maintainability, and allows for more dynamic and flexible interactions between LLMs and external utilities.
Pages are loaded by default from the `~/.robopages/` directory (or any folder set in the `ROBOPAGES_PATH` environment variable), see the `https://github.com/dreadnode/robopages` repository for examples.
## Install with Cargo
This is the recommended way to install and use the tool:
```bash
cargo install robopages
```
## Pull from Docker Hub
```bash
docker pull dreadnode/robopages:latest
```
## Build Docker image
To build your own Docker image for the tool, run:
```bash
docker build . -t robopages
```
Optionally, you can create a bash alias like so:
`alias robopages='docker run -v /var/run/docker.sock:/var/run/docker.sock -v ~/.robopages:/root/.robopages -p 8000:8000 robopages'`
## Note about Docker
If you are using `robopages` inside a container, make sure to share the docker socket from the host machine with the container:
```bash
docker run -it \
# allow the container itself to instrument docker on the host \
-v/var/run/docker.sock:/var/run/docker.sock
# share your robopages
-v$HOME/.robopages:/root/.robopages \
# the rest of the command line
robopages view
```
## Build from source
Alternatively you can build the project from source, in which case you'll need to have Rust and Cargo [installed on your system](https://rustup.rs/) and clone this repository.
To build the project:
```bash
cargo build --release
```
The compiled binary will be available in the `target/release` directory. You can run it directly or add it to your system's PATH:
```bash
# Run directly
./target/release/robopages
# Or, copy to a directory in your PATH (e.g., /usr/local/bin)
sudo cp target/release/robopages /usr/local/bin/
```
## Usage
This project consists of a CLI for creating, viewing and serving robopages as a REST API.
### CLI
Install robopages:
```bash
# install https://github.com/dreadnode/robopages to ~/.robopages/
robopages install
# install a custom repository
robopages install --source user/repo
# install from a local archive
robopages install --source /path/to/archive.zip
```
View installed robopages:
```bash
robopages view
```
Create a robopage with the preferred template:
```bash
# create with the basic template, will run the command in the current shell
robopages create --name my_first_page.yml --template basic
# create with the docker-image template, will use a docker image to run the command
robopages create --name my_first_page.yml --template docker-image
# create with the docker-build template, will build a docker image to run the command
robopages create --name my_first_page.yml --template docker-build
```
Validate one or more files:
```bash
# validate all pages in ~/.robopages
robopages validate
# validate a specific page
robopages validate --path my_first_page.yml
# do not attempt to pull or build containers
robopages validate --skip-docker
```
Start the REST API:
> [!IMPORTANT]
> While strict CORS rules are enforced by default, no authentication layer is provided. It is highly recommended to never bind this API to addresses other than localhost (as per default configuration).
```bash
# this will pre build and pull all containers
robopages serve
# this will build or pull containers on demand
robopages serve --lazy
```
Execute a function manually without user interaction:
```bash
robopages run --function nikto_scan --auto
```
You can also define variables to be used in the function call:
```bash
robopages run -F httpx_tech_detect -A --define target=www.example.com
```
Repeat for multiple variables:
```bash
robopages run -F function_name -A -D target=www.example.com -D foo=bar
```
#### SSH
The `run` and `serve` commands support an optional SSH connection string. If provided, commands will be executed over SSH on the given host.
```bash
robopages serve --ssh user@host:port --ssh-key ~/.ssh/id_ed25519
```
> [!IMPORTANT]
> * Setting a SSH connection string will override any container configuration.
> * If the function requires sudo, the remote host is expected to have passwordless sudo access.
### Using with LLMs
The examples folder contains integration examples for [Rigging](/examples/rigging_example.py), [OpenAI](/examples/openai_example.py), [Groq](/examples/groq_example.py), [OLLAMA](/examples/ollama_example.py) and [Nerve](/examples/nerve.md).
## Docker Container Failures
If a function's required Docker container fails to pull (e.g., due to missing permissions or non-existent image), the function will fail to execute. To resolve this:
1. Either gain access to the required container, or
2. Remove the robopage file that references the inaccessible container
This behavior is intentional to prevent functions from executing without their required runtime dependencies.