luxferre/Sidekick
1
0
Fork 0
Code Actions Activity

updated the readme

Browse Source
This commit is contained in:
Luxferre
2026-03-21 16:32:30 +02:00
parent c2bc527b30
commit a2af89e61f
1 changed files with 7 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -12
View File
@@ -1,6 +1,6 @@
# Sidekick # Sidekick
Sidekick is a production-ready agentic framework written in Go 1.25. It provides a robust architecture for building AI assistants with hierarchical orchestration, native Model Context Protocol (MCP) integration, and a rich terminal user interface (TUI). Sidekick is a versatile agentic framework written in Go 1.25. It provides a robust architecture for building AI assistants with hierarchical orchestration, native Model Context Protocol (MCP) integration, and a rich terminal user interface (TUI).
## Features ## Features
@@ -108,6 +108,10 @@ user's request and delegate tasks accordingly.
```bash ```bash
./bin/sidekick-tui ./bin/sidekick-tui
``` ```
* **Input:** Type your messages at the bottom prompt.
* **Send:** Press `Enter` to send a message.
* **Quit:** Press `ctrl+c` to exit.
* **Scrolling:** Use the mouse wheel or arrow keys to scroll through the conversation history.
### Running the Sidekick MCP Server ### Running the Sidekick MCP Server
@@ -129,11 +133,6 @@ port = 8080 # for sse/http
The server provides a `query` tool that routes requests to your coordinator agent, maintaining conversation history if provided. The server provides a `query` tool that routes requests to your coordinator agent, maintaining conversation history if provided.
* **Input:** Type your messages at the bottom prompt.
* **Send:** Press `Enter` to send a message.
* **Quit:** Press `ctrl+c` to exit.
* **Scrolling:** Use the mouse wheel or arrow keys to scroll through the conversation history.
### Using the Framework Programmatically ### Using the Framework Programmatically
```go ```go
@@ -180,10 +179,6 @@ func main() {
} }
``` ```
## Contributing ## Credits
Contributions are welcome! Please ensure that all code adheres to the project's strict coding standards defined in `AGENTS.md` (e.g., 2-space indentation, max 112 characters per line, double-quoted strings). Created by Luxferre in 2026, released into public domain with no warranties.
## License
MIT