Skip to content

Commit 93778aa

Browse files
committed
docs: updated README
1 parent 8e5db06 commit 93778aa

File tree

2 files changed

+39
-2
lines changed

2 files changed

+39
-2
lines changed

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM rust:bullseye as builder
1+
FROM rust:bullseye AS builder
22

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

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,54 @@
11
# Robopages CLI and Function Calling Server
22

3+
<p align="center">
4+
<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>
5+
<a href="https://crates.io/crates/robopages"><img alt="Crate" src="https://img.shields.io/crates/v/robopages.svg"></a>
6+
<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>
7+
<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>
8+
<a href="#"><img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/dreadnode/robopages-cli/test.yml"></a>
9+
<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>
10+
</p>
11+
312
[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.
413

514
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.
615

16+
## Install with Cargo
17+
18+
This is the recommended way to install and use the tool:
19+
20+
```bash
21+
cargo install robopages
22+
```
23+
24+
## Pull from Docker Hub
25+
26+
```bash
27+
docker pull dreadnode/robopages:latest
28+
```
29+
730
## Build Docker image
831

9-
To build the Docker image for the tool, run:
32+
To build your own Docker image for the tool, run:
1033

1134
```bash
1235
docker build . -t robopages
1336
```
1437

38+
## Note about Docker
39+
40+
If you are using `robopages` inside a container, make sure to share the docker socket from the host machine with the container:
41+
42+
```bash
43+
docker run -it \
44+
# allow the container itself to instrument docker on the host \
45+
-v/var/run/docker.sock:/var/run/docker.sock
46+
# share your robopages
47+
-v$HOME/.robopages:/root/.robopages \
48+
# the rest of the command line
49+
robopages view
50+
```
51+
1552
## Build from source
1653

1754
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.

0 commit comments

Comments
 (0)