{"id":13395111,"url":"https://github.com/tmattio/spin","last_synced_at":"2025-10-27T00:32:48.151Z","repository":{"id":44729897,"uuid":"225292536","full_name":"tmattio/spin","owner":"tmattio","description":"OCaml project generator.","archived":false,"fork":false,"pushed_at":"2024-10-07T15:13:09.000Z","size":1290,"stargazers_count":296,"open_issues_count":14,"forks_count":15,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-04-01T17:17:36.654Z","etag":null,"topics":["dune","esy","ocaml","reason","spin","template"],"latest_commit_sha":null,"homepage":"","language":"OCaml","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tmattio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGES.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2019-12-02T05:27:10.000Z","updated_at":"2025-01-28T22:26:21.000Z","dependencies_parsed_at":"2024-11-13T19:00:59.938Z","dependency_job_id":"06efa447-07ad-449b-a8b7-febd5cc3b3f5","html_url":"https://github.com/tmattio/spin","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmattio%2Fspin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmattio%2Fspin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmattio%2Fspin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tmattio%2Fspin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tmattio","download_url":"https://codeload.github.com/tmattio/spin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247898519,"owners_count":21014722,"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":["dune","esy","ocaml","reason","spin","template"],"created_at":"2024-07-30T17:01:42.389Z","updated_at":"2025-10-27T00:32:43.116Z","avatar_url":"https://github.com/tmattio.png","language":"OCaml","funding_links":[],"categories":["OCaml","Project Starter Templates"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003cimg width=\"300\" src=\"https://raw.githubusercontent.com/tmattio/spin/main/doc/logo.svg?sanitize=true\" alt=\"Logo\"\u003e\n  \t\u003cbr\u003e\u003cbr\u003e\n    OCaml project generator.\n\u003c/p\u003e\n\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/tmattio/spin/actions\"\u003e\n    \u003cimg src=\"https://github.com/tmattio/spin/workflows/CI/badge.svg\" alt=\"Build Status\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://badge.fury.io/js/%40tmattio%2Fspin\"\u003e\n    \u003cimg src=\"https://badge.fury.io/js/%40tmattio%2Fspin.svg\" alt=\"npm version\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"#features\"\u003eFeatures\u003c/a\u003e •\n  \u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e •\n  \u003ca href=\"#templates\"\u003eTemplates\u003c/a\u003e •\n  \u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e •\n  \u003ca href=\"#roadmap\"\u003eRoadmap\u003c/a\u003e •\n  \u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e •\n  \u003ca href=\"#license\"\u003eLicense\u003c/a\u003e •\n  \u003ca href=\"#acknowledgements\"\u003eAcknowledgements\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/tmattio/spin/main/doc/demo.svg?sanitize=true\" alt=\"Demo\"\u003e\n\u003c/div\u003e\n\n## Features\n\n🚀 Quickly start new projects that are ready for the real world.\n\n❤️ Have a great developer experience when developing with OCaml.\n\n🏄 Be as productive as Ruby-on-Rails or Elixir's Mix users.\n\n🔌 Establish a convention for projects organizations to make it easy to get into new projects.\n\n## Installation\n\n### Using Homebrew (macOS)\n\n```bash\nbrew install tmattio/tap/spin\n```\n\n### Using Opam\n\n```bash\nopam install spin\n```\n\n### Using a script\n\n```bash\ncurl -fsSL https://github.com/tmattio/spin/raw/main/script/install.sh | bash\n```\n\n## Templates\n\nYou can generate a new project using a template with `spin new`. For instance:\n\n```bash\nspin new bin my_app\n```\n\nWill create a new binary application in the directory `./my_app/`\n\nAnyone can create new Spin templates, but we provide official templates for a lot of use cases.\n\n### Official templates\n\nThe official Spin templates templates are the following:\n\n- **bin** - Native project containing a binary.\n- **cli** - Command Line Interface releasable on Opam.\n- **lib** - Library releasable on Opam.\n- **ppx** - PPX library.\n- **c-bindings** - Bindings to a C library.\n- **js** - Js application with Js_of_ocaml.\n\nIf you'd like to add an official template, don't hesitate to open a PR!\n\n### Other OCaml templates\n\nYou can find community Spin templates for various projects here: [https://github.com/ocaml-templates](https://github.com/ocaml-templates)\n\nHere are some non-official Spin templates that you can use:\n\n- [**spin-sihl**](https://github.com/oxidizing/spin-sihl) - Spin template for [Sihl](https://github.com/oxidizing/sihl) applications\n\n### Other non-OCaml templates\n\nAlthough the focus of Spin is to offer a great project generator for the OCaml ecosystem, it can also be used to generate non-OCaml templates. Here are a few examples:\n\n- [**spin-python-cli**](https://github.com/tmattio/spin-python-cli) - Spin template for Python CLIs\n\n## Usage\n\nFor a detailed documentation of Spin's CLI, run `spin --help`, or refer to the [CLI documentation](https://github.com/tmattio/spin/tree/main/doc/cli.md).\n\n### `spin new TEMPLATE [PATH] [--default] [--ignore-config]`\n\nCreate a new ReasonML/Ocaml project from a template.\n\n`PATH` defaults to the current working directory.\n\nWhen `--default` is passed, the user will not be prompted for configurations that have a default value.\n\nWhen `--ignore-config` is passed, the configuration file will be ignored and the user will be prompted for all the configurations.\n\n### `spin ls`\n\nList the official Spin templates.\n\n### `spin config`\n\nPrompt the user for values that can be saved in the configuration file.\n\nIf a value is present in the configuration file, it will not be prompted when generating a new project.\n\n## Roadmap\n\nSee our [development board](https://github.com/tmattio/spin/projects/1) for a list of selected features and issues.\n\nHere are some of the improvements we'll be working on as well in for next releases:\n\n- [ ] Support windows\n- [ ] Support CLI options/args for configurations\n- [ ] Minimal `hello` template\n- [ ] Generators for `lib/bin/test` for all templates\n\n## Contributing\n\nWe'd love your help improving Spin!\n\nTake a look at our [Contributing Guide](CONTRIBUTING.md) to get started.\n\n## License\n\nDistributed under the ISC License. See [LICENSE](LICENSE) for more information.\n\n## Acknowledgements\n\nThanks to everyone who [contributed](https://github.com/tmattio/spin/graphs/contributors) to Spin!\n\nSpecial thanks to [@wesoudshoorn](https://github.com/wesoudshoorn) for creating Spin's logo.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmattio%2Fspin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftmattio%2Fspin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftmattio%2Fspin/lists"}