{"id":17436201,"url":"https://github.com/pigeonposse/env-ai","last_synced_at":"2026-05-19T03:20:11.455Z","repository":{"id":257827350,"uuid":"873116422","full_name":"pigeonposse/env-ai","owner":"pigeonposse","description":"An AI assistant tool for your terminal, designed to help you with tasks like documentation, performance optimization, refactoring, and more, using custom commands.","archived":false,"fork":false,"pushed_at":"2025-05-09T12:02:49.000Z","size":450,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-15T08:45:59.706Z","etag":null,"topics":["ai","bun","cli","deno","documentation","node","typescript"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/env-ai","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pigeonposse.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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},"funding":{"github":"pigeonposse","open_collective":"pigeonposse","ko_fi":"pigeonposse","custom":["pigeonposse.com/contribute"]}},"created_at":"2024-10-15T16:17:52.000Z","updated_at":"2025-06-02T12:45:36.000Z","dependencies_parsed_at":"2024-11-14T15:58:19.888Z","dependency_job_id":"ef0ec92a-a195-4e20-9642-50597ed63efd","html_url":"https://github.com/pigeonposse/env-ai","commit_stats":{"total_commits":28,"total_committers":1,"mean_commits":28.0,"dds":0.0,"last_synced_commit":"e306ade9a1c4abcfe97280d8a6412dfb2b79f9d8"},"previous_names":["pigeonposse/env-ai"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/pigeonposse/env-ai","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pigeonposse%2Fenv-ai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pigeonposse%2Fenv-ai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pigeonposse%2Fenv-ai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pigeonposse%2Fenv-ai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pigeonposse","download_url":"https://codeload.github.com/pigeonposse/env-ai/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pigeonposse%2Fenv-ai/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266682625,"owners_count":23967837,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"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","bun","cli","deno","documentation","node","typescript"],"created_at":"2024-10-17T10:06:41.608Z","updated_at":"2026-05-19T03:20:11.421Z","avatar_url":"https://github.com/pigeonposse.png","language":"TypeScript","funding_links":["https://github.com/sponsors/pigeonposse","https://opencollective.com/pigeonposse","https://ko-fi.com/pigeonposse","pigeonposse.com/contribute"],"categories":[],"sub_categories":[],"readme":"\n# env-ai - AI Assistant for Your Local Environment\n\n[![Web](https://img.shields.io/badge/Web-grey?style=for-the-badge\u0026logoColor=white)](https://pigeonposse.com)\n[![About Us](https://img.shields.io/badge/About%20Us-grey?style=for-the-badge\u0026logoColor=white)](https://pigeonposse.com?popup=about)\n[![Donate](https://img.shields.io/badge/Donate-pink?style=for-the-badge\u0026logoColor=white)](https://pigeonposse.com/?popup=donate)\n[![Github](https://img.shields.io/badge/Github-black?style=for-the-badge\u0026logo=github\u0026logoColor=white)](https://github.com/pigeonposse)\n[![Twitter](https://img.shields.io/badge/Twitter-black?style=for-the-badge\u0026logo=twitter\u0026logoColor=white)](https://twitter.com/pigeonposse_)\n[![Instagram](https://img.shields.io/badge/Instagram-black?style=for-the-badge\u0026logo=instagram\u0026logoColor=white)](https://www.instagram.com/pigeon.posse/)\n[![Medium](https://img.shields.io/badge/Medium-black?style=for-the-badge\u0026logo=medium\u0026logoColor=white)](https://medium.com/@pigeonposse)\n\n[![License](https://img.shields.io/github/license/pigeonposse/env-ai?color=green\u0026style=for-the-badge\u0026logoColor=white)](/LICENSE)\n[![Core](https://img.shields.io/npm/v/env-ai?color=blue\u0026style=for-the-badge\u0026logoColor=white)](https://www.npmjs.com/package/env-ai)\n\n**env-ai** is an intelligent assistant tool for your terminal, designed to help you with tasks like documentation, performance optimization, refactoring, and more, using custom commands.\n\n\u003e [!IMPORTANT]\n\u003e **env-ai** needs the **[Ollama](https://ollama.com)** technology to work. Make sure you have it installed before using this CLI.\n\n## 📑 Index\n\n- [🌟 Features](#-features)\n- [📦 Installation](#-installation)\n- [📖 Using the CLI](#-using-the-cli)\n  - [Main Commands](#main-commands)\n  - [Options](#options)\n- [📚 Using the Library](#-using-the-library)\n  - [Import Example](#import-example)\n  - [Defined Configuration](#defined-configuration)\n- [🔍 Examples](#-examples)\n- [👨‍💻 Development](#-development)\n- [☕ Donate](#-donate)\n- [📜 License](#-license)\n- [🐦 About Us](#-about-us)\n\n## 🌟 Features\n\n- 💬 **Real-Time Chat**: Interact with the AI assistant directly from your terminal.\n- 🗃️ **Robust context**: Accepts URL and local file inputs so the wizard has more precise context of what to do.\n- 🎨 **Extensive Customization**: Configure themes, inputs and outputs to your liking.\n- 📄 **Configuration File Support**: Make your chat systems portable. Compatible with multiple formats, including `.mjs`, `.js`, `.json`, `.yml`, `.yaml`, `.toml`, and `.tml`.\n- ✈️ **Portable**: Create a chat system, save it in a configuration file and use it for other projects.\n- 🌐 **Multiple Environments**:\n  - 📦 **JavaScript Library**: Easily integrable into your projects.\n  - 💻 **Command Line Interface (CLI)**: Works in:\n    - 🟢 **Node.js**\n    - 🦕 **Deno**\n    - 🍞 **Bun**\n  - 🚀 **Binary**: Available for all operating systems and architectures via [GitHub Releases](https://github.com/pigeonposse/env-ai/releases).\n\n## 📦 Installation\n\nInstall the CLI or add it as a dependency to your project:\n\n```bash\n## npm\nnpm install env-ai\n## pnpm\npnpm add env-ai\n## yarn\nyarn add env-ai\n# bun\nbun add env-ai\n# deno\ndeno add env-ai\n```\n\n### global Installation\n\n```bash\n## npm\nnpm install -g env-ai\n## pnpm\npnpm add -g env-ai\n## yarn\nyarn global add env-ai\n```\n\n### without Installation\n\n```bash\n## npm\nnpx env-ai\n## pnpm\npnpx env-ai\n```\n\n## 📖 Using the CLI\n\nThe **env-ai** CLI allows you to easily interact with the AI assistant. Here are some useful commands and options:\n\n### Main Commands\n\n```bash\n# Start a chat with the AI assistant\nenv-ai chat\n```\n\n### Options\n\n- `-i, --input` - Path patterns or URLs to be processed. *(array)*\n- `-m, --model` - Name of the Ollama model to use. *(string)*\n- `-p, --prompt` -  Fist prompt to generate a response (text, path or url). *(string)*\n- `-s, --system` - Custom system text or path. *(string)*\n- `-t, --theme` - Topic of conversation (`custom`, `explain`, `docs`, `fix`, `performance`, `refactor`, `tests`). *(string)*\n- `-o, --output` - Output path for the generated response. *(string)*\n- `--overwrite` - Behavior control if the output file exists (`always`, `ask`, `last`). *(boolean)*\n- `--single` - Get only one response. *(boolean)*\n- `-c, --config` - Path to config file. Files supported: [.mjs|.js|.json|.yml|.yaml|.toml|.tml]. *(string)*\n- `--debug` - Debug mode. *(boolean)*\n- `-h, --help` - Show help. *(boolean)*\n- `-v, --version` - Show version number. *(boolean)*\n\n## 📚 Using the Library\n\n**env-ai** can also be integrated as a library into your `JavaScript` or `TypeScript` project.\n\n### Import Example\n\n```javascript\nimport { run } from 'env-ai';\n\nrun({\n    input: ['./src/**', 'https://example.com'],\n    theme: 'docs',\n    output: 'README.md',\n});\n```\n\n### Defined Configuration\n\nUse `defineConfig` to define a reusable configuration:\n\n```javascript\nimport { defineConfig } from 'env-ai';\n\nexport default defineConfig({\n    input: ['./src/**', 'https://example.com'],\n    theme: 'docs',\n    output: 'README.md',\n});\n```\n\n## 🔍 Examples\n\nYou can see more examples [here](./examples).\n\n### CLI\n\n```bash\nenv-ai chat -i \"./src/**\" -t \"docs\" -o \"output.md\"\n```\n\n### Library\n\n```javascript\nimport { run } from 'env-ai';\n\nrun({\n    input: ['./src/**', 'https://example.com'],\n    theme: 'docs',\n    output: 'README.md',\n});\n```\n\n### CLI With `js` config file\n\n```bash\nenv-ai chat --config dovenv.config.js\n```\n\n```js\nimport { defineConfig } from 'env-ai';\n\nexport default defineConfig({\n    model: 'llama3.2:latest',\n    input: ['./src/**', 'https://example.com'],\n    theme: 'docs',\n    output: 'README.md',\n});\n```\n\n### CLI With `json` config file\n\n```bash\nenv-ai chat --config dovenv.config.json\n```\n\n```json\n{\n    \"theme\": \"custom\",\n    \"system\": \"./your-system-content.txt\"\n}\n```\n\n### CLI With `toml` config file\n\n```bash\nenv-ai chat --config documentation-context.toml\n```\n\n```toml\ntheme = \"docs\"\ninput = [\"./docs\", \"./src\"]\nsystem = \"\"\"\nYou are a helpful assistant explaining how to use the provided code library and provide detailed documentation.\nThe content for the following code library:\n\n{{content}}\n\"\"\"\n```\n\n### CLI With `yaml` config file\n\n```bash\nenv-ai chat --config dovenv.config.yaml\n```\n\n```yaml\ntheme: custom\nsystem: ./your-system-content.md\n```\n\n### CLI - Input with excluded files\n\nIt includes all SRC files that are at the upper level.\n\n```bash\nenv-ai chat -i 'src/*' '!src/../*' -t 'docs' -o 'output.md'\n```\n\n## 👨‍💻 Development\n\n**env-ai** is an open-source project and its development is open to anyone who wants to participate.\n\n[![TODO](https://img.shields.io/badge/TODO-grey?style=for-the-badge)](./docs/todo/)\n[![Issues](https://img.shields.io/badge/Issues-grey?style=for-the-badge)](https://github.com/pigeonposse/env-ai/issues)\n[![Pull requests](https://img.shields.io/badge/Pulls-grey?style=for-the-badge)](https://github.com/pigeonposse/env-ai/pulls)\n[![Read more](https://img.shields.io/badge/Read%20more-grey?style=for-the-badge)](https://env-ai.pigeonposse.com/)\n\n## ☕ Donate\n\nHelp us to develop more interesting things.\n\n[![Donate](https://img.shields.io/badge/Donate-grey?style=for-the-badge)](https://pigeonposse.com/?popup=donate)\n\n## 📜 License\n\nThis software is licensed with **[GPL-3.0](/LICENSE)**.\n\n[![Read more](https://img.shields.io/badge/Read-more-grey?style=for-the-badge)](/LICENSE)\n\n## 🐦 About us\n\n*PigeonPosse* is a ✨ **code development collective** ✨ focused on creating practical and interesting tools that help developers and users enjoy a more agile and comfortable experience. Our projects cover various programming sectors and we do not have a thematic limitation in terms of projects.\n\n[![More](https://img.shields.io/badge/Read-more-grey?style=for-the-badge)](https://github.com/pigeonposse)\n\n### Collaborators\n\n|                                                                                    | Name        | Role         | GitHub                                         |\n| ---------------------------------------------------------------------------------- | ----------- | ------------ | ---------------------------------------------- |\n| \u003cimg src=\"https://github.com/angelespejo.png?size=72\" alt=\"Angelo\" style=\"border-radius:100%\"/\u003e | Angelo |   Idea \u0026 Development \u0026 UI Design   | [@angelespejo](https://github.com/angelespejo) |\n| \u003cimg src=\"https://github.com/PigeonPosse.png?size=72\" alt=\"PigeonPosse\" style=\"border-radius:100%\"/\u003e | PigeonPosse | Collective | [@PigeonPosse](https://github.com/PigeonPosse) |\n\n\u003cbr\u003e\n\u003cp align=\"center\"\u003e\n\n[![Web](https://img.shields.io/badge/Web-grey?style=for-the-badge\u0026logoColor=white)](https://pigeonposse.com)\n[![About Us](https://img.shields.io/badge/About%20Us-grey?style=for-the-badge\u0026logoColor=white)](https://pigeonposse.com?popup=about)\n[![Donate](https://img.shields.io/badge/Donate-pink?style=for-the-badge\u0026logoColor=white)](https://pigeonposse.com/?popup=donate)\n[![Github](https://img.shields.io/badge/Github-black?style=for-the-badge\u0026logo=github\u0026logoColor=white)](https://github.com/pigeonposse)\n[![Twitter](https://img.shields.io/badge/Twitter-black?style=for-the-badge\u0026logo=twitter\u0026logoColor=white)](https://twitter.com/pigeonposse_)\n[![Instagram](https://img.shields.io/badge/Instagram-black?style=for-the-badge\u0026logo=instagram\u0026logoColor=white)](https://www.instagram.com/pigeon.posse/)\n[![Medium](https://img.shields.io/badge/Medium-black?style=for-the-badge\u0026logo=medium\u0026logoColor=white)](https://medium.com/@pigeonposse)\n\n\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpigeonposse%2Fenv-ai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpigeonposse%2Fenv-ai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpigeonposse%2Fenv-ai/lists"}