luccibot

README

Luccibot

Luccibot is a self-hosted, CLI-based personal crypto manager and assistant written in Go. It is designed to help users efficiently manage cryptocurrency portfolios, track real-time market trends, and receive personalized insights directly from the terminal.

Because it is self-hosted, you retain full control over your data. You can securely store private keys and CEX API credentials locally on your own machine, ensuring sensitive information never leaves your control.

Features

• Self-Hosted & Secure: Run locally to keep your private keys and exchange API tokens safe.
• Portfolio Management: Track your assets across different wallets and exchanges (Planned).
• Market Tracking: Real-time price updates and trend analysis (Planned).
• Personalized Insights: AI-driven recommendations for your portfolio (Planned).
• CLI Interface: Fast and scriptable command-line interface powered by Cobra.

Getting Started

Prerequisites

• Go 1.24+

Installation

Clone the repository and build the binary:

git clone https://github.com/lucci-labs/luccibot.git
cd luccibot
make build

This will create the luccibot binary in the bin/ directory.

Usage

Run the bot using the binary:

./bin/luccibot [command] [flags]

Or using go run:

go run cmd/luccibot/main.go [command]

Development

This project follows a flat directory structure for simplicity and ease of navigation.

Project Structure

.
├── agent/              # LLM Agent "Brain" logic
├── bin/                # Compiled binaries
├── bridge/             # Interface to external skills/scripts ("Hands")
├── bus/                # Event bus and communication channels
├── cmd/                # Entry points (Cobra commands)
├── docs/               # Documentation
├── logger/             # Logging utilities
├── skills/             # External scripts (TypeScript/Bun)
├── tui/                # Terminal User Interface ("Face")
├── vault/              # Secure signing and key management ("Wallet")
├── .github/workflows/  # CI/CD configurations
├── Makefile            # Build and task automation
└── README.md           # This file

Common Tasks

We use make for common development tasks:

• make build: Compiles the application to bin/luccibot.
• make run: Builds and runs the application.
• make test: Runs all unit tests.
• make lint: Runs go vet (and golangci-lint if installed).
• make clean: Removes build artifacts.

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md file for details on our code of conduct and the process for submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.