{"id":34048181,"url":"https://github.com/far3x/lumen","last_synced_at":"2026-03-12T19:13:45.282Z","repository":{"id":279934298,"uuid":"940489500","full_name":"far3x/lumen","owner":"far3x","description":"The official CLI for the Lumen Protocol \u0026 Local Prompt Generation.","archived":false,"fork":false,"pushed_at":"2025-10-29T23:02:37.000Z","size":1579,"stargazers_count":73,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-15T17:26:44.138Z","etag":null,"topics":["ai","client","code","lumen","reward"],"latest_commit_sha":null,"homepage":"https://lumen.onl/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/far3x.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-02-28T09:12:22.000Z","updated_at":"2025-12-01T22:05:49.000Z","dependencies_parsed_at":null,"dependency_job_id":"02e1afb7-9993-4b31-9fcd-391b511b3729","html_url":"https://github.com/far3x/lumen","commit_stats":null,"previous_names":["far3000-yt/ptap","far3000-yt/lumen","far3x/lumen"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/far3x/lumen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/far3x%2Flumen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/far3x%2Flumen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/far3x%2Flumen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/far3x%2Flumen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/far3x","download_url":"https://codeload.github.com/far3x/lumen/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/far3x%2Flumen/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30439636,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-12T14:34:45.044Z","status":"ssl_error","status_checked_at":"2026-03-12T14:09:33.793Z","response_time":114,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","client","code","lumen","reward"],"created_at":"2025-12-14T00:01:43.672Z","updated_at":"2026-03-12T19:13:45.276Z","avatar_url":"https://github.com/far3x.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./assets/logo.jpg\" alt=\"Lumen Logo\" width=\"200\"\u003e\n\u003c/p\u003e\n\n\u003ch2 align=\"center\"\u003e\n  The official CLI for the Lumen Protocol \u0026 Local Prompt Generation.\n\u003c/h2\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://badge.fury.io/py/pylumen\"\u003e\u003cimg src=\"https://badge.fury.io/py/pylumen.svg\" alt=\"PyPI version\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://pepy.tech/project/pylumen\"\u003e\u003cimg src=\"https://static.pepy.tech/badge/pylumen\" alt=\"Downloads\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/pylumen/\"\u003e\u003cimg src=\"https://img.shields.io/pypi/pyversions/pylumen.svg\" alt=\"Python Version\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://opensource.org/licenses/MIT\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-MIT-yellow.svg\" alt=\"License: MIT\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/far3x/lumen/actions/workflows/release.yaml\"\u003e\u003cimg src=\"https://github.com/far3x/lumen/actions/workflows/release.yaml/badge.svg\" alt=\"Build Status\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/far3x/lumen/blob/main/CONTRIBUTING.md\"\u003e\u003cimg src=\"https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat\" alt=\"Contributions welcome\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://lumen.onl/docs/introduction\"\u003e\u003cimg src=\"https://img.shields.io/badge/docs-lumen.onl-13131A.svg\" alt=\"Documentation\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/far3x/lumen/stargazers/\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/far3x/lumen.svg?style=social\u0026label=Star\" alt=\"GitHub stars\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n---\n\nCA : BkpaxHhE6snExazrPkVAjxDyZa8Nq3oDEzm5GQm2pump\n\n### Table of Contents\n\n-   [Why Lumen?](#why-lumen)\n-   [Features](#features)\n-   [Prerequisites](#prerequisites)\n-   [Installation \u0026 Troubleshooting](#installation--troubleshooting)\n-   [Commands](#commands)\n    -   [Network Commands](#network-commands)\n    -   [Local Prompt Generation](#local-prompt-generation)\n    -   [Configuration](#configuration)\n-   [Documentation](#documentation)\n-   [Contributing](#contributing)\n-   [License](#license)\n\n---\n\n\u003ch2 id=\"why-lumen\"\u003eWhy Lumen?\u003c/h2\u003e\n\nLumen 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.\n\n1.  **A Best-in-Class Local Prompt Helper:** A 100% private utility for your daily AI-assisted development.\n2.  **A Gateway to the Data Economy:** A secure bridge to the Lumen Protocol, allowing developers to ethically contribute their anonymized code and earn rewards.\n\nIf you find the local tools useful, please consider **starring the repository!**\n\n\u003ch2 id=\"features\"\u003eFeatures\u003c/h2\u003e\n\n*   **Network Interaction:** Securely contribute your anonymized code to the Lumen Protocol and track your submission history.\n*   **Local Prompt Generation:** Assemble entire codebases into a single, LLM-ready prompt without sending any data.\n*   **100% Local Anonymization:** All code sanitization for protocol contributions happens on your machine. Your raw code is never uploaded.\n*   **Smart File Handling:** Intelligently respects `.gitignore`, ignores dotfiles, parses Jupyter Notebooks (`.ipynb`) (locally), and uses an optimized / custom-built + unique file reading strategy.\n*   **GitHub Repository Support:** Analyze any public GitHub repository directly by providing its URL.\n*   **Token Usage Analysis:** Identify the most token-heavy files in a project to manage context window limitations.\n*   **Customizable Filtering:** Use the CLI or edit a simple `config.json` file to control which files, folders, and types are processed.\n\n\u003ch2 id=\"prerequisites\"\u003ePrerequisites\u003c/h2\u003e\n\n1.  **Python (3.7 or higher):** Check with `python --version`.\n2.  **Git:** Required only for analyzing GitHub repositories (`-g` flag). Check with `git --version`.\n\n\u003ch2 id=\"installation--troubleshooting\"\u003eInstallation \u0026 Troubleshooting\u003c/h2\u003e\n\nInstall directly from PyPI:\n```bash\npip install pylumen\n```\n\nTo upgrade to the latest version:\n```bash\npip install --upgrade pylumen\n```\n\n#### Troubleshooting `command not found: lum`\nThis occurs when the `pip` scripts directory is not in your system's PATH.\n\n*   **Quick Fix:** Run the tool as a Python module: `python -m lum --version`.\n*   **Permanent Fix (Recommended):**\n    *   **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.\n    *   **Windows:** Reinstall Python and ensure the \"Add Python to PATH\" checkbox is selected.\n\n\u003ch2 id=\"commands\"\u003eCommands\u003c/h2\u003e\n\n### Network Commands\nThese commands interact with the Lumen Protocol backend.\n\n**Authorize Device**\nInitiates the secure login flow to link your CLI to a Lumen account.\n```bash\nlum login\n```\n\n**Contribute Code**\nAnalyzes, sanitizes, and submits the current project to the Lumen network.\n```bash\nlum contribute\n```\n\n**View History**\nDisplays the status of your last 10 contributions.\n```bash\nlum history\n```\n\n**De-authorize Device**\nLogs out and securely removes the local authentication token.\n```bash\nlum logout\n```\n\n### Local Prompt Generation\nThese commands do **not** send any data to the network.\n\n**Analyze Current Directory**\nAssembles the project into a prompt and copies it to your clipboard.\n```bash\nlum local\n```\n\n**Save Prompt to File**\nSaves the prompt to a `.txt` file instead of copying.\n```bash\nlum local -t my_project_prompt\n```\n\n**Analyze a GitHub Repository**\nClones a public repo to a temporary directory for analysis.\n```bash\nlum local -g https://github.com/user/repo-name\n```\n\n**Identify Token-Heavy Files**\nShows a leaderboard of the most token-consuming files.\n```bash\n# See the top 20 (default) files\nlum local -l\n\n# See the top 10 files\nlum local -l 10\n```\n\n\u003ch3 id=\"configuration\"\u003eConfiguration\u003c/h3\u003e\n\n**Edit Configuration**\nOpens `config.json` in your system's default text editor.\n```bash\nlum config --edit\n```\n\n**Reset Configuration**\nResets all settings in `config.json` to their default values.\n```bash\nlum config --reset\n```\n\n**Set a Specific Value**\nChanges a single setting directly from the terminal.\n```bash\n# Enable a boolean setting\nlum config --set use_ai_instructions true\n\n# Overwrite a list (provide as a comma-separated string)\nlum config --set skipped_files \".DS_Store,yarn.lock\"\n```\n\n---\n\n\u003ch2 id=\"documentation\"\u003eDocumentation\u003c/h2\u003e\n\nFor detailed documentation on the Lumen Protocol, including the valuation engine, security practices, and our long-term vision, please visit our official documentation site.\n\n-   [Installation Guide](https://lumen.onl/docs/installation)\n-   [CLI Authentication](https://lumen.onl/docs/authentication)\n-   [Protocol Valuation Engine](https://lumen.onl/docs/valuation)\n-   [Security by Design](https://lumen.onl/docs/security)\n-   [The Lumen Whitepaper](https://lumen.onl/docs/whitepaper)\n\n\u003ch2 id=\"contributing\"\u003eContributing\u003c/h2\u003e\n\nContributions, issues, and feature requests are welcome! Please check the [issues page](https://github.com/far3x/lumen/issues) and see `CONTRIBUTING.md` for details.\n\n\u003ch2 id=\"license\"\u003eLicense\u003c/h2\u003e\n\nThis project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffar3x%2Flumen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffar3x%2Flumen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffar3x%2Flumen/lists"}