From 124a31501e351f3e6779079885ffffd4683e437e Mon Sep 17 00:00:00 2001 From: Ads Dawson <104169244+GangGreenTemperTatum@users.noreply.github.com> Date: Thu, 6 Feb 2025 08:12:26 -0500 Subject: [PATCH 1/2] docs: readme addition for container pull errs --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 15f5231..16a22fa 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,18 @@ Software License

+- [Robopages Server](#robopages-server) + - [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. @@ -165,8 +177,17 @@ 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. +> * 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). \ No newline at end of file +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. \ No newline at end of file From 1001531f61c24647633dd17cbd6af67ec50acdf1 Mon Sep 17 00:00:00 2001 From: Ads Dawson <104169244+GangGreenTemperTatum@users.noreply.github.com> Date: Thu, 6 Feb 2025 08:17:01 -0500 Subject: [PATCH 2/2] docs: logo and sub-header --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 16a22fa..437705a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # Robopages Server +
+ +Logo + + +

Release Crate @@ -9,7 +21,15 @@ Software License

+## 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) @@ -21,6 +41,7 @@ - [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.