@obsfx/trekker 1.0.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -0
- package/dist/index.js +574 -628
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -171,6 +171,21 @@ Trekker creates a `.trekker` directory in your project root containing `trekker.
|
|
|
171
171
|
|
|
172
172
|
Run `trekker quickstart` to see the full guide with best practices for creating atomic tasks, writing good descriptions, and managing dependencies.
|
|
173
173
|
|
|
174
|
+
## How I Use It
|
|
175
|
+
|
|
176
|
+
This is my personal workflow for getting the most out of Trekker with AI agents:
|
|
177
|
+
|
|
178
|
+
- **Always mention Trekker in prompts.** I include "use trekker" in my instructions so the agent knows to track its work.
|
|
179
|
+
|
|
180
|
+
- **Point agents to the quickstart.** I tell the agent it can run `trekker quickstart` to learn how to use Trekker properly. This gives it all the context it needs without me having to explain everything.
|
|
181
|
+
|
|
182
|
+
- **Use the dashboard for visibility.** I run [trekker-dashboard](https://github.com/obsfx/trekker-dashboard) to visually track what the agent is doing. It shows tasks on a kanban board and auto-refreshes, so I can monitor progress in real-time.
|
|
183
|
+
|
|
184
|
+
Example prompt snippet:
|
|
185
|
+
```
|
|
186
|
+
Use trekker to track your work. Run `trekker quickstart` if you need to learn how it works.
|
|
187
|
+
```
|
|
188
|
+
|
|
174
189
|
## License
|
|
175
190
|
|
|
176
191
|
MIT
|