https://github.com/far3x/lumen
The official CLI for the Lumen Protocol & Local Prompt Generation.
https://github.com/far3x/lumen
ai client code lumen reward
Last synced: 11 days ago
JSON representation
The official CLI for the Lumen Protocol & Local Prompt Generation.
- Host: GitHub
- URL: https://github.com/far3x/lumen
- Owner: far3x
- License: mit
- Created: 2025-02-28T09:12:22.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-10-29T23:02:37.000Z (5 months ago)
- Last Synced: 2025-12-15T17:26:44.138Z (3 months ago)
- Topics: ai, client, code, lumen, reward
- Language: Python
- Homepage: https://lumen.onl/
- Size: 1.51 MB
- Stars: 73
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
The official CLI for the Lumen Protocol & Local Prompt Generation.
---
CA : BkpaxHhE6snExazrPkVAjxDyZa8Nq3oDEzm5GQm2pump
### Table of Contents
- [Why Lumen?](#why-lumen)
- [Features](#features)
- [Prerequisites](#prerequisites)
- [Installation & Troubleshooting](#installation--troubleshooting)
- [Commands](#commands)
- [Network Commands](#network-commands)
- [Local Prompt Generation](#local-prompt-generation)
- [Configuration](#configuration)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
---
Why Lumen?
Lumen is a dual-purpose CLI designed for developers. It began as a powerful local tool to solve the tedious process of manual context building for LLMs and evolved into a gateway for developers to ethically contribute to the AI data economy.
1. **A Best-in-Class Local Prompt Helper:** A 100% private utility for your daily AI-assisted development.
2. **A Gateway to the Data Economy:** A secure bridge to the Lumen Protocol, allowing developers to ethically contribute their anonymized code and earn rewards.
If you find the local tools useful, please consider **starring the repository!**
Features
* **Network Interaction:** Securely contribute your anonymized code to the Lumen Protocol and track your submission history.
* **Local Prompt Generation:** Assemble entire codebases into a single, LLM-ready prompt without sending any data.
* **100% Local Anonymization:** All code sanitization for protocol contributions happens on your machine. Your raw code is never uploaded.
* **Smart File Handling:** Intelligently respects `.gitignore`, ignores dotfiles, parses Jupyter Notebooks (`.ipynb`) (locally), and uses an optimized / custom-built + unique file reading strategy.
* **GitHub Repository Support:** Analyze any public GitHub repository directly by providing its URL.
* **Token Usage Analysis:** Identify the most token-heavy files in a project to manage context window limitations.
* **Customizable Filtering:** Use the CLI or edit a simple `config.json` file to control which files, folders, and types are processed.
Prerequisites
1. **Python (3.7 or higher):** Check with `python --version`.
2. **Git:** Required only for analyzing GitHub repositories (`-g` flag). Check with `git --version`.
Installation & Troubleshooting
Install directly from PyPI:
```bash
pip install pylumen
```
To upgrade to the latest version:
```bash
pip install --upgrade pylumen
```
#### Troubleshooting `command not found: lum`
This occurs when the `pip` scripts directory is not in your system's PATH.
* **Quick Fix:** Run the tool as a Python module: `python -m lum --version`.
* **Permanent Fix (Recommended):**
* **macOS/Linux:** Find your Python script path (often `~/.local/bin`) and add it to your shell configuration (`~/.zshrc`, `~/.bashrc`): `export PATH="$HOME/.local/bin:$PATH"`. Restart your terminal.
* **Windows:** Reinstall Python and ensure the "Add Python to PATH" checkbox is selected.
Commands
### Network Commands
These commands interact with the Lumen Protocol backend.
**Authorize Device**
Initiates the secure login flow to link your CLI to a Lumen account.
```bash
lum login
```
**Contribute Code**
Analyzes, sanitizes, and submits the current project to the Lumen network.
```bash
lum contribute
```
**View History**
Displays the status of your last 10 contributions.
```bash
lum history
```
**De-authorize Device**
Logs out and securely removes the local authentication token.
```bash
lum logout
```
### Local Prompt Generation
These commands do **not** send any data to the network.
**Analyze Current Directory**
Assembles the project into a prompt and copies it to your clipboard.
```bash
lum local
```
**Save Prompt to File**
Saves the prompt to a `.txt` file instead of copying.
```bash
lum local -t my_project_prompt
```
**Analyze a GitHub Repository**
Clones a public repo to a temporary directory for analysis.
```bash
lum local -g https://github.com/user/repo-name
```
**Identify Token-Heavy Files**
Shows a leaderboard of the most token-consuming files.
```bash
# See the top 20 (default) files
lum local -l
# See the top 10 files
lum local -l 10
```
Configuration
**Edit Configuration**
Opens `config.json` in your system's default text editor.
```bash
lum config --edit
```
**Reset Configuration**
Resets all settings in `config.json` to their default values.
```bash
lum config --reset
```
**Set a Specific Value**
Changes a single setting directly from the terminal.
```bash
# Enable a boolean setting
lum config --set use_ai_instructions true
# Overwrite a list (provide as a comma-separated string)
lum config --set skipped_files ".DS_Store,yarn.lock"
```
---
Documentation
For detailed documentation on the Lumen Protocol, including the valuation engine, security practices, and our long-term vision, please visit our official documentation site.
- [Installation Guide](https://lumen.onl/docs/installation)
- [CLI Authentication](https://lumen.onl/docs/authentication)
- [Protocol Valuation Engine](https://lumen.onl/docs/valuation)
- [Security by Design](https://lumen.onl/docs/security)
- [The Lumen Whitepaper](https://lumen.onl/docs/whitepaper)
Contributing
Contributions, issues, and feature requests are welcome! Please check the [issues page](https://github.com/far3x/lumen/issues) and see `CONTRIBUTING.md` for details.
License
This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.