{"id":31802525,"url":"https://github.com/alireza29675/yar-agent","last_synced_at":"2025-10-11T00:48:27.883Z","repository":{"id":318397875,"uuid":"1069311694","full_name":"Alireza29675/yar-agent","owner":"Alireza29675","description":"Yar — Understand Complex Codebases Fast ⚡ 🚀","archived":false,"fork":false,"pushed_at":"2025-10-07T00:20:42.000Z","size":445,"stargazers_count":1,"open_issues_count":8,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-07T00:43:44.914Z","etag":null,"topics":["agent","claude-agent-sdk","code-analysis","code-understanding","yar"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Alireza29675.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"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-10-03T18:21:17.000Z","updated_at":"2025-10-07T00:20:27.000Z","dependencies_parsed_at":"2025-10-07T00:44:17.708Z","dependency_job_id":"b86693bc-1ea6-4cd8-a28a-0a1d93dea252","html_url":"https://github.com/Alireza29675/yar-agent","commit_stats":null,"previous_names":["alireza29675/yar-agent"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/Alireza29675/yar-agent","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alireza29675%2Fyar-agent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alireza29675%2Fyar-agent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alireza29675%2Fyar-agent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alireza29675%2Fyar-agent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Alireza29675","download_url":"https://codeload.github.com/Alireza29675/yar-agent/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Alireza29675%2Fyar-agent/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279005654,"owners_count":26083942,"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-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","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":["agent","claude-agent-sdk","code-analysis","code-understanding","yar"],"created_at":"2025-10-11T00:48:25.819Z","updated_at":"2025-10-11T00:48:27.876Z","avatar_url":"https://github.com/Alireza29675.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yar — Understand Complex Codebases Fast\n\n[![npm version](https://badge.fury.io/js/yar-agent.svg)](https://www.npmjs.com/package/yar-agent)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nYar is an CLI agent, built with [Claude Agent SDK](https://docs.claude.com/en/api/agent-sdk/overview), which analyzes complex and large codebases and generate documentation. It reads code, understands architecture, and creates **onboarding guides and presentations** automatically.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./docs/assets/yar-cli.gif\" width=\"45%\" alt=\"CLI Command\" /\u003e\n  \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n  \u003cimg src=\"./docs/assets/output.gif\" width=\"45%\" alt=\"Generated Presentation\" /\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003cem\u003eRun CLI command → Get presentation\u003c/em\u003e\n\u003c/p\u003e\n\n## ⚙️ Installation\n\n```bash\nnpm install -g yar-agent\n```\n\n### 📋 Requirements\n\n- Node.js 18+\n- [Claude Code CLI](https://claude.com/code) installed and configured\n\n## 🤖 Usage\n\n### Study a codebase\n\n```bash\nyar study .\n```\n\nCreates `GUIDE.md` by default. Customize output:\n\n```bash\nyar study . -o ONBOARDING.md\n```\n\n\u003e see this onboarding guide, generated by Yar: [CONTRIBUTOR_ONBOARDING.md](./CONTRIBUTOR_ONBOARDING.md)\n\nor direct the agent to focus on specific areas:\n\n```bash\nyar study . -m \"I'm joining this project as security engineer. Focus on security patterns\"\n```\n\n### Trace Codebase history\n\n```bash\nyar timeline .\n```\n\nCreates `TIMELINE.md` by default. Customize output:\n\n```bash\nyar timeline . -o HISTORY.md\n```\n\n### Create a presentation\n\nTo consume the documentations faster, you can use Yar to quickly generate a presentation:\n\n```bash\nyar present -f GUIDE.md\n```\n\nCreates `GUIDE.slides.html` and serves it by default. Customize:\n\n```bash\nyar present -f GUIDE.md -o onboarding.html --no-serve\n```\n\nor combine multiple documentations into a single presentation:\n\n```bash\nyar present -f ONBOARDING.md -f TIMELINE.md\n```\n\nor direct the agent to focus on specific aspects, or style the presentation:\n\n```bash\nyar present -f ONBOARDING.md -f TIMELINE.md -m \"Explain the API layer more detailed, and of course use dark theme with blue accents!\"\n```\n\nComplete usage documentation: [USAGE.md](./USAGE.md)\n\n## ➕ Features\n\n**Autonomous exploration**: AI agents use Read, Grep, Glob, and other tools to navigate code like a developer would.\n\n**Automatic updates**: Running commands on existing output files updates them with new findings rather than overwriting.\n\n**CI/CD integration**: Can be run in GitHub Actions or other CI systems to keep documentation current.\n\n```yaml\n- name: Update documentation\n  run: yar study .\n```\n\n\u003e 💡 Tip: if the output file already exists, Yar will first read it and then automatically update it with new findings rather than overwriting it completely.\n\n**Progressive output**: Agents write analysis incrementally using Write and Edit tools, with file access restricted to specified output paths.\n\n**Piped input**: Accepts stdin for additional context.\n\n```bash\ngit diff | yar study .\n```\n\n## 🤝 Contributing\n\nSee [CONTRIBUTOR_ONBOARDING.md](./CONTRIBUTOR_ONBOARDING.md) for architecture and development workflow.\n\nUpdate the contributor guide:\n```bash\npnpm onboarding:update\n```\n\n## Why this name?\n\nIn Farsi (my mother language), YAR (یار) means companion.\n\n## Links\n\n- [npm package](https://www.npmjs.com/package/yar-agent)\n- [GitHub](https://github.com/Alireza29675/yar)\n- [Issues](https://github.com/Alireza29675/yar/issues)\n\n## License\n\nMIT © Alireza Sheikholmolouki\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falireza29675%2Fyar-agent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falireza29675%2Fyar-agent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falireza29675%2Fyar-agent/lists"}