Skip to content

Commit 75fc5ff

Browse files
authored
Revise README for clarity and usage instructions
Updated the README to clarify the purpose of the repository and added a section on how to use capabilities.
1 parent 2a64374 commit 75fc5ff

1 file changed

Lines changed: 5 additions & 46 deletions

File tree

README.md

Lines changed: 5 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -20,60 +20,19 @@ Dreadnode Capabilities
2020

2121
</br>
2222

23-
A capability is a portable bundle that extends a Dreadnode runtime with everything an agent needs to do a job — agent prompts, Python tools, skills, MCP servers, background workers, and sandbox setup — driven by a single `capability.yaml`. This repository is the public source of the capabilities Dreadnode authors and ships to the platform.
24-
25-
```yaml
26-
# capability.yaml
27-
schema: 1
28-
name: web-recon
29-
version: "0.1.0"
30-
description: Basic host reconnaissance.
31-
```
32-
33-
```python
34-
# tools/lookup.py
35-
import typing as t
36-
from dreadnode import tool
37-
38-
@tool
39-
def lookup_host(host: t.Annotated[str, "Hostname or IP to look up"]) -> dict[str, str]:
40-
"""Resolve a host and return basic metadata."""
41-
return {"host": host, "status": "reachable"}
42-
```
43-
44-
That's a working capability. The loader auto-discovers `agents/`, `tools/`, `skills/`, and `mcp/` from the directory, so the manifest stays small.
45-
46-
## Where capabilities run
47-
48-
- **Platform catalog** — browse and install everything published to your workspace at [app.dreadnode.io/capabilities](https://app.dreadnode.io/capabilities).
49-
- **TUI capability manager** — open `dn`, press `Ctrl+P` to install, enable, and inspect capabilities on a running runtime.
50-
- **Local checkout** — drop a capability directory in `~/.dreadnode/capabilities/` (or anywhere on `DREADNODE_CAPABILITY_DIRS`) and the runtime picks it up.
51-
52-
Every capability in this repo syncs to the platform on push to `main` via the [sync workflow](.github/workflows/sync.yml).
53-
54-
## Documentation
23+
This repo maintains the source for all our capabilities published to [app.dreadnode.io](https://app.dreadnode.io).
5524

5625
Full reference for the manifest, components, discovery rules, installation, and publishing lives in the docs:
5726

5827
**[docs.dreadnode.io/capabilities/overview](https://docs.dreadnode.io/capabilities/overview/)**
5928

6029
For an end-to-end walkthrough — scaffold, write a tool and an agent, install locally, drive it from the TUI — start with the [Quickstart](https://docs.dreadnode.io/capabilities/quickstart/).
6130

62-
## Local development
31+
## How to use
6332

64-
Validate every manifest in the repo:
65-
66-
```bash
67-
just validate
68-
```
69-
70-
Mirror the repo into your local capability store so a `dn` runtime sees the changes:
71-
72-
```bash
73-
just sync-dreadnode-files # rsyncs capabilities/* into ~/.dreadnode/capabilities/
74-
```
75-
76-
Pre-commit hooks run `ruff`, `ruff-format`, `check-yaml`, and `gitleaks`. Don't bypass them — fix the underlying issue.
33+
- **Install in the TUIr** — start `dn`, press `Ctrl+P` and find one of the `dreadnode/` capabilities.
34+
- **Browse the catalog** — interactively browse everything published at [app.dreadnode.io](https://app.dreadnode.io).
35+
- **Local checkout** — drop a capability directory in `~/.dreadnode/capabilities/` (or anywhere on `DREADNODE_CAPABILITY_DIRS`) and the runtime picks it up.
7736

7837
## Security scanning
7938

0 commit comments

Comments
 (0)