bunware.org
forked from
cameron.stream/void
this repo has no description
docs: update readme
+86
-12
README.md
+86
-12
README.md
···
30
30
31
31
## Getting Started
32
32
33
-
Before continuing, you must make sure you have created a project on Letta Cloud (or your instance) and have somewhere to run this on.
33
+
Before continuing, you must:
34
+
35
+
1. Create a project on [Letta Cloud](https://cloud.letta.com) (or your own Letta instance)
36
+
2. Have a Bluesky account
37
+
3. Have Python 3.8+ installed
38
+
39
+
### Prerequisites
40
+
41
+
#### 1. Letta Setup
42
+
43
+
- Sign up for [Letta Cloud](https://cloud.letta.com)
44
+
- Create a new project
45
+
- Note your Project ID and create an API key
46
+
47
+
#### 2. Bluesky Setup
48
+
49
+
- Create a Bluesky account if you don't have one
50
+
- Note your handle and password
34
51
35
-
### Running the bot locally
52
+
### Installation
53
+
54
+
#### 1. Clone the repository
55
+
56
+
```bash
57
+
git clone https://tangled.sh/@cameron.pfiffer.org/void && cd void
58
+
```
36
59
37
-
#### Install dependencies
60
+
#### 2. Install dependencies
38
61
39
-
```shell
62
+
```bash
40
63
pip install -r requirements.txt
41
64
```
42
65
43
-
#### Create `.env`
66
+
#### 3. Create configuration
44
67
45
-
Copy `.env.example` (`cp .env.example .env`) and fill out the fields.
68
+
Copy the example configuration file and customize it:
46
69
47
-
#### Create configuration
70
+
```bash
71
+
cp config.example.yaml config.yaml
72
+
```
48
73
49
-
Copy `config.example.yaml` and fill out your configuration. See [`CONFIG.md`](/CONFIG.md) to learn more.
74
+
Edit `config.yaml` with your credentials:
50
75
51
-
#### Register tools
76
+
```yaml
77
+
letta:
78
+
api_key: "your-letta-api-key-here"
79
+
project_id: "your-project-id-here"
52
80
53
-
```shell
54
-
py .\register_tools.py <AGENT_NAME> # your agent's name on letta
81
+
bluesky:
82
+
username: "your-handle.bsky.social"
83
+
password: "your-app-password-here"
84
+
85
+
bot:
86
+
agent:
87
+
name: "void" # or whatever you want to name your agent
55
88
```
56
89
57
-
Contact:
90
+
See [`CONFIG.md`](/CONFIG.md) for detailed configuration options.
91
+
92
+
#### 4. Test your configuration
93
+
94
+
```bash
95
+
python test_config.py
96
+
```
97
+
98
+
This will validate your configuration and show you what's working.
99
+
100
+
#### 5. Register tools with your agent
101
+
102
+
```bash
103
+
python register_tools.py
104
+
```
105
+
106
+
This will register all the necessary tools with your Letta agent. You can also:
107
+
108
+
- List available tools: `python register_tools.py --list`
109
+
- Register specific tools: `python register_tools.py --tools search_bluesky_posts create_new_bluesky_post`
110
+
- Use a different agent name: `python register_tools.py my-agent-name`
111
+
112
+
#### 6. Run the bot
113
+
114
+
```bash
115
+
python bsky.py
116
+
```
117
+
118
+
For testing mode (won't actually post):
119
+
120
+
```bash
121
+
python bsky.py --test
122
+
```
123
+
124
+
### Troubleshooting
125
+
126
+
- **Config validation errors**: Run `python test_config.py` to diagnose configuration issues
127
+
- **Letta connection issues**: Verify your API key and project ID are correct
128
+
- **Bluesky authentication**: Make sure you're handle and password are correct and that you can log into your account
129
+
- **Tool registration fails**: Ensure your agent exists in Letta and the name matches your config
130
+
131
+
### Contact
58
132
For inquiries, please contact @cameron.pfiffer.org on Bluesky.
59
133
60
134
Note: void is an experimental project and its capabilities are under continuous development.