{"id":18619863,"url":"https://github.com/garrettpeake/pioche","last_synced_at":"2025-07-18T22:05:53.812Z","repository":{"id":57664269,"uuid":"470718940","full_name":"GarrettPeake/pioche","owner":"GarrettPeake","description":"A fully typed framework turning less work into better Cloudflare Workers","archived":false,"fork":false,"pushed_at":"2022-06-05T21:57:40.000Z","size":397,"stargazers_count":4,"open_issues_count":6,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-18T03:51:55.296Z","etag":null,"topics":["cloudflare","cloudflare-workers","framework","serverless","workers","workers-kv"],"latest_commit_sha":null,"homepage":"","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/GarrettPeake.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}},"created_at":"2022-03-16T19:10:13.000Z","updated_at":"2022-09-23T18:53:56.000Z","dependencies_parsed_at":"2022-09-26T21:40:33.533Z","dependency_job_id":null,"html_url":"https://github.com/GarrettPeake/pioche","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/GarrettPeake/pioche","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GarrettPeake%2Fpioche","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GarrettPeake%2Fpioche/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GarrettPeake%2Fpioche/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GarrettPeake%2Fpioche/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/GarrettPeake","download_url":"https://codeload.github.com/GarrettPeake/pioche/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/GarrettPeake%2Fpioche/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265844807,"owners_count":23837658,"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":["cloudflare","cloudflare-workers","framework","serverless","workers","workers-kv"],"created_at":"2024-11-07T04:03:36.724Z","updated_at":"2025-07-18T22:05:53.767Z","avatar_url":"https://github.com/GarrettPeake.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv\u003e\n  \u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/GarrettPeake/pioche\" title=\"View Project Source\"\u003e\n      \u003cimg width=\"375\" src=\"https://github.com/GarrettPeake/pioche/blob/master/readme_logo.png\" /\u003e\n    \u003c/a\u003e\n  \u003c/p\u003e\n \n  \u003cdiv align=\"center\"\u003e\n    \u003cp\u003e**PIOCHE IS IN ALPHA AND SHOULD NOT BE USED IN PRODUCTION**\u003c/p\u003e\n    \u003cp\u003eTypeScript first framework for \u003ca href='https://workers.cloudflare.com'\u003eCloudflare Workers\u003c/a\u003e enabling ⚡lightning⚡ fast development and execution\u003c/p\u003e\n  \u003c/div\u003e\n\n  \u003ca href=\"https://www.npmjs.com/package/pioche\"\u003e\n    \u003cimg src=\"https://badgen.net/npm/v/pioche?color=blue\" alt=\"npm version\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\nNote: To use Durable Objects and Websockets features of Pioche, you need a Cloudflare account with [Durable Objects access](https://developers.cloudflare.com/workers/learning/using-durable-objects/#using-durable-objects-1)\n\n## ⭐ Features\n - [x] Short development time\n - [x] Decorator-based path-to-regexp router\n - [x] Middleware support\n - [x] Simplified, more powerful API for D/O Storage and KV  \n - [x] Simplified Worker -\u003e D/O interaction\n - [x] WebSocket handling\n - [x] Minimized invokations and compute time  \n## 🔋 Tree Shakeable Batteries Available in [pioche-extras](https://github.com/GarrettPeake/pioche-extras)\n\nSee the installation section of [pioche-extras](https://github.com/GarrettPeake/pioche-extras) for prebuilt OAuth, log streaming, and middleware to use in your project\n\n## 💾 Installation\n\nTo get started use [pioche-scripts](https://github.com/GarrettPeake/pioche-scripts)\n```\nnpx pioche-scripts create \u003cAppName\u003e\n```\nThis will setup an minimal project with a single TypeScript file: helloworld.ts  \nWe can then make changes to functionality and run\n```js\nnpm run build // Generate wrangler.toml and program entry point\nnpm run dev // Deploy to Cloudflare with remote debugging session\nnpm run serve // Run locally, debug locally\nnpm run deploy // Deploy to Cloudflare\n```\nAfter `npm run deploy` you should see `\u003cAppName\u003e.workers.dev` gives `Hello, World!`\n\n## 📕 Background and why Pioche Exists\n\nCloudflare (CF) workers platform has 3 major offerings:\n\n1. **Workers**: A serverless javascript environment for short lived code. There can be many of the same worker script executing globally at the same time\n\n2. **Durable Objects (D/O)**: A serverless javascript environment for long lived code or code which requires transactional storage. There can only be one of a D/O script globally at the same time.\n\n3. **Workers KV (KV)**: A non-transactional distributed key-value store\n\nWorkers are web-facing, D/Os are Workers-facing, KV Workers and D/O-facing.  \n**Problem**: There is a cumbersome dispatch process to call a D/O from a worker.\n\nD/Os have an in-memory key value store (D/O storage)  \n**Problem**: This store has very similar capabilities but use a separate API from KV. \n\nCPU time is charged per GB-sec, storage operations are charged per kB transferred, and Workers and D/Os are charged per invokation.  \n**Problem**: We want to only use D/Os when necessary and minimize CPU time and invokations.  \n\n**Problem**: There is no routing functionality\n\nThese 4 issues alone greatly increase upstart development time and complexity because orchestrating routing between services and resource management while minimizing cost is a huge task that developers shouldn't need to handle.\n\n## People\n\nPioche was created by [Garrett Peake](https://github.com/GarrettPeake)\n\n## License\n [MIT](https://github.com/GarrettPeake/pioche/blob/master/LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgarrettpeake%2Fpioche","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgarrettpeake%2Fpioche","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgarrettpeake%2Fpioche/lists"}