Skip to content

Commit

Permalink
docs: updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
evilsocket committed Oct 31, 2024
1 parent 8e5db06 commit 93778aa
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 2 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM rust:bullseye as builder
FROM rust:bullseye AS builder

RUN apt-get update && apt-get install -y libssl-dev ca-certificates cmake git

Expand Down
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,54 @@
# Robopages CLI and Function Calling Server

<p align="center">
<a href="https://github.com/dreadnode/robopages-cli/releases/latest"><img alt="Release" src="https://img.shields.io/github/release/dreadnode/robopages-cli.svg?style=fl_pathat-square"></a>
<a href="https://crates.io/crates/robopages"><img alt="Crate" src="https://img.shields.io/crates/v/robopages.svg"></a>
<a href="https://hub.docker.com/r/dreadnode/robopages"><img alt="Docker Hub" src="https://img.shields.io/docker/v/dreadnode/robopages?logo=docker"></a>
<a href="https://rust-reportcard.xuri.me/report/github.com/dreadnode/robopages-cli"><img alt="Rust Report" src="https://rust-reportcard.xuri.me/badge/github.com/dreadnode/robopages-cli"></a>
<a href="#"><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/dreadnode/robopages-cli/test.yml"></a>
<a href="https://github.com/dreadnode/robopages-cli/blob/master/LICENSE.md"><img alt="Software License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square"></a>
</p>

[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 the Docker image for the tool, run:
To build your own Docker image for the tool, run:

```bash
docker build . -t 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.
Expand Down

0 comments on commit 93778aa

Please sign in to comment.