{"id":32352602,"url":"https://github.com/osbuild/decomposer","last_synced_at":"2026-07-10T20:31:41.312Z","repository":{"id":314102173,"uuid":"1046192269","full_name":"osbuild/decomposer","owner":"osbuild","description":"Lightweight TypeScript shim for the image-builder-cli","archived":false,"fork":false,"pushed_at":"2026-03-16T11:59:10.000Z","size":45,"stargazers_count":0,"open_issues_count":0,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-17T00:26:03.853Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/osbuild.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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-28T10:23:26.000Z","updated_at":"2026-03-16T11:59:14.000Z","dependencies_parsed_at":"2025-09-10T17:29:57.212Z","dependency_job_id":"2ae3c3da-0614-42c8-8c7c-49d26fcf0c6e","html_url":"https://github.com/osbuild/decomposer","commit_stats":null,"previous_names":["osbuild/decomposer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/osbuild/decomposer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osbuild%2Fdecomposer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osbuild%2Fdecomposer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osbuild%2Fdecomposer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osbuild%2Fdecomposer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osbuild","download_url":"https://codeload.github.com/osbuild/decomposer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osbuild%2Fdecomposer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":35343135,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-07-10T02:00:06.465Z","response_time":60,"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":[],"created_at":"2025-10-24T10:01:46.179Z","updated_at":"2026-07-10T20:31:41.306Z","avatar_url":"https://github.com/osbuild.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# decomposer\n\nA lightweight TypeScript HTTP server that acts as a shim for image-builder-cli. Built with Bun and Hono, it provides a Unix socket-based API with automatic OpenAPI type generation from the image-builder-crc repo.\n\n## Prerequisites\n\n- [Bun](https://bun.sh/) \u003e= 1.0.0\n- Node.js \u003e= 18 (for TypeScript compilation)\n\n### Installing Bun\n\n```bash\nnpm install -g bun\n```\n\n## Installation\n\n1. Clone the repository:\n\n```bash\ngit clone \u003crepository-url\u003e\ncd decomposer\n```\n\n2. Install dependencies:\n\n```bash\nbun install\n```\n\n3. Generate OpenAPI types:\n\n```bash\nbun generate\n```\n\n## Usage\n\n### Development\n\nStart the development server with hot reload:\n\n```bash\nbun dev\n```\n\n### Custom Configuration\n\nYou can specify a custom store path:\n\n```bash\nSTORE_PATH=/custom/path/to/store bun start\n```\n\nOr pass it as a command-line argument:\n\n```bash\nbun start --store /custom/path/to/store\n```\n\nOr in a .env file:\n\n```.env\nSTORE_PATH=/custom/path/to/store\n```\n\n### Endpoints\n\nSee the [list of supported endpoints](./src/api/README.md) and how to make requests from your terminal.\n\n### Socket Location\n\nThe server listens on a Unix socket at `/run/decomposer-httpd.sock` with permissions set to `775` for multi-user access.\n\n## Development Workflow\n\n### Code Generation\n\nThe project includes tools to automatically generate TypeScript types from OpenAPI specifications:\n\n1. **Filter OpenAPI spec**:\n\n   ```bash\n   bun api:filter\n   ```\n\n   This downloads the latest OpenAPI spec from image-builder-crc and filters it to include only relevant endpoints.\n\n2. **Generate TypeScript types**:\n\n   ```bash\n   bun api:generate\n   ```\n\n   This generates TypeScript interfaces and Zod schemas from the filtered OpenAPI spec.\n\n3. **Run both steps**:\n   ```bash\n   bun generate\n   ```\n\n### Document generation\n\nSome of the endpoint documentation and example requests are generated. If you have added\nnew endpoints, ensure you add some `TSDocs` with the endpoint description. If the module\nis new, you might have to add it to `tools/docs/markdown.ts`.\n\n1. **Generate **:\n   ```bash\n   bun docs\n   ```\n\n### Code Quality\n\n- **Linting**: `bun lint`\n- **Formatting**: `bun format`\n- **Format Check**: `bun format:check`\n- **Testing**: `bun test`\n- **Type Check**: `bun check`\n- **Circular Dependency Check**: `bun circular`\n\n## Contributing\n\n1. Fork the repository\n2. Create a feature branch\n3. Make your changes\n4. Run the test suite: `bun test`\n5. Ensure code quality: `bun lint \u0026\u0026 bun format:check`\n6. Submit a pull request\n\n## License\n\nThis project is licensed under the Apache License 2.0. See the [LICENSE](LICENSE) file for details.\n\n## Related Projects\n\n- [image-builder-cli](https://github.com/osbuild/image-builder-cli) - The command line tool used to build the images\n- [image-builder-crc](https://github.com/osbuild/image-builder-crc) - The upstream image builder service\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosbuild%2Fdecomposer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosbuild%2Fdecomposer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosbuild%2Fdecomposer/lists"}