{"id":27934300,"url":"https://github.com/g4brym/aletria","last_synced_at":"2025-10-31T09:36:00.584Z","repository":{"id":282626131,"uuid":"932725330","full_name":"G4brym/aletria","owner":"G4brym","description":"Simple AI CLI that generates docs, unit tests and README.md files","archived":false,"fork":false,"pushed_at":"2025-03-15T22:51:30.000Z","size":29,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-18T14:59:07.764Z","etag":null,"topics":["ai","cli","gemini","gemini-ai","generator","generator-ai","google","npm"],"latest_commit_sha":null,"homepage":"http://npmjs.com/aletria","language":"TypeScript","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/G4brym.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}},"created_at":"2025-02-14T12:04:35.000Z","updated_at":"2025-04-13T17:45:23.000Z","dependencies_parsed_at":"2025-03-15T22:19:49.932Z","dependency_job_id":null,"html_url":"https://github.com/G4brym/aletria","commit_stats":null,"previous_names":["g4brym/aletria"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/G4brym%2Faletria","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/G4brym%2Faletria/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/G4brym%2Faletria/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/G4brym%2Faletria/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/G4brym","download_url":"https://codeload.github.com/G4brym/aletria/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252823595,"owners_count":21809705,"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","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","cli","gemini","gemini-ai","generator","generator-ai","google","npm"],"created_at":"2025-05-07T05:36:20.700Z","updated_at":"2025-10-31T09:35:55.523Z","avatar_url":"https://github.com/G4brym.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aletria\n\naletria is a CLI tool designed to help developers integrate AI-driven features into their codebases. Leveraging the\nimpressive context size of Gemini 2.0, aletria automates the generation of unit tests, project documentation, and README\nfiles, streamlining your development workflow.\n\nA big focus of this project is privacy.\n - No data (except the generated docs and code) is stored anywhere.\n - Your API key is only stored in memory locally on your machine, meaning once the cli is closed there is no way to retrieve it.\n - Your code is only sent to Google API for inference, and nothing is sent to any other service.\n\n\n**This is very much experimental work!!**\nPlease make sure you have commited your work before starting this tool, in order to avoid having files edited that you didn't want.\n\n## Features\n\n- **Multi-File Documentation Generation**\n  Combine your source code, unit tests, README.md, and other files to produce detailed, markdown-based documentation for\n  your project.\n\n### Coming up features\nThis is not available yet, but will soon!\n- **AI-Powered Unit Test Generation**\n  Automatically parse your source code files and generate comprehensive unit tests.\n\n- **Dynamic README Generation**\n  Generate a professional project README.md by parsing your source code, unit tests, and a brief description of your\n  project.\n\n## Getting Started\n\n### Prerequisites\n\n- At least Node.js 20\n- A Google AI Studio API key\n\n### Installation\n\n```bash\nnpx aletria@latest\n```\n\n### Configuration\n\naletria requires a Google AI Studio API key, this will either be retrieved from the environment using the name `GOOGLE_API_KEY`\nor the tool, will ask you to fill the key when starting a task.\n\nYou may define the inline while calling, like this:\n```bash\nGOOGLE_API_KEY=your_api_key_here npx aletria@latest\n```\n\n## Usage\n\naletria provides a simple CLI interface to execute its main functions. Here’s how you can get started:\n\n### 1. Generate Documentation\n\nParse your source code, unit tests, README.md, and additional project files to generate comprehensive markdown\ndocumentation:\n\n```bash\nnpx aletria@latest generate-docs -i ./src -o ./docs\n```\n\n### 2. Generate Unit Tests\n\n**This is not available yet!**\n\nParse all source code files and generate unit tests:\n\n```bash\nnpx aletria@latest generate-tests -i ./src -o ./tests\n```\n\n### 3. Generate Project README\n\n**This is not available yet!**\n\nGenerate a project README.md by parsing your source code, unit tests, and a brief project description:\n\n```bash\nnpx aletria@latest generate-readme -i ./src -i ./package.json -o ./README.md\n```\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fg4brym%2Faletria","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fg4brym%2Faletria","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fg4brym%2Faletria/lists"}