{"id":19528914,"url":"https://github.com/adonisjs/create-adonisjs","last_synced_at":"2026-02-28T21:05:12.706Z","repository":{"id":182492986,"uuid":"663636655","full_name":"adonisjs/create-adonisjs","owner":"adonisjs","description":"Scaffolding tool to create AdonisJS 7 projects","archived":false,"fork":false,"pushed_at":"2026-02-25T05:19:12.000Z","size":90,"stargazers_count":21,"open_issues_count":0,"forks_count":5,"subscribers_count":3,"default_branch":"3.x","last_synced_at":"2026-02-25T10:42:52.944Z","etag":null,"topics":[],"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/adonisjs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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},"funding":{"github":"thetutlage"}},"created_at":"2023-07-07T19:01:16.000Z","updated_at":"2026-02-25T05:19:16.000Z","dependencies_parsed_at":"2024-06-19T12:42:20.074Z","dependency_job_id":"e7d8fcd8-3339-4b7e-a522-db461a1655a0","html_url":"https://github.com/adonisjs/create-adonisjs","commit_stats":null,"previous_names":["adonisjs/create-adonisjs"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/adonisjs/create-adonisjs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs%2Fcreate-adonisjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs%2Fcreate-adonisjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs%2Fcreate-adonisjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs%2Fcreate-adonisjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adonisjs","download_url":"https://codeload.github.com/adonisjs/create-adonisjs/tar.gz/refs/heads/3.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adonisjs%2Fcreate-adonisjs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29879895,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-26T23:51:21.483Z","status":"ssl_error","status_checked_at":"2026-02-26T23:50:46.793Z","response_time":89,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":"2024-11-11T01:20:47.873Z","updated_at":"2026-02-28T21:05:12.673Z","avatar_url":"https://github.com/adonisjs.png","language":"TypeScript","funding_links":["https://github.com/sponsors/thetutlage"],"categories":[],"sub_categories":[],"readme":"# create-adonisjs\n\nScaffold a new AdonisJS application using starter kits\n\n\u003cbr /\u003e\n\n[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]\n\n## Starter kits\n\nYou can use between one of the following official starter kits, or bring your own using the `--kit` flag.\n\n- `api` : AdonisJS application tailored for building HTTP APIs.\n- `web` : AdonisJS application tailored for building server-side rendered applications.\n- `slim` : Smallest possible AdonisJS application. Still way more powerful and batteries included than a express application.\n- `inertia`: AdonisJS application tailored for building applications using InertiaJS and your favorite frontend framework (Vue, React, Svelte, Solid).\n\n## Usage\n\n```sh\n# Using npm\nnpm init adonisjs\n\n# Using yarn\nyarn create adonisjs\n\n# Using pnpm\npnpm create adonisjs\n```\n\n## Options\n\n### `destination`\n\nYou can pass the destination directory as the first argument to the command. For example:\n\n```sh\nnpm init adonisjs my-app\n```\n\nThis argument is optional and the command will prompt you to enter the directory name if not provided.\n\n\u003e **Note** - The directory must be empty otherwise the command will fail.\n\n### `--kit` (Default: Triggers prompt for selection)\n\nIf you want to use your own starter kit hosted on Github, Gitlab, or Bitbucket, you can use the `--kit` flag to define the repo URL.\n\n```sh\n# Download from GitHub\nnpm init adonisjs -- --kit=\"github:github_user/repo\"\n\n# Github is the default provider, so if not specified, it will be assumed as github\nnpm init adonisjs -- --kit=\"github_user/repo\"\n\n# Download from GitLab\nnpm init adonisjs -- --kit=\"gitlab:user/repo\"\n\n# Download from BitBucket\nnpm init adonisjs -- --kit=\"bitbucket:user/repo\"\n```\n\nYou can also pass specify the branch or tag name as follows:\n\n```sh\n# Branch name\nnpm init adonisjs -- --kit=\"github:github_user/repo#branch-name\"\n\n# Tag name\nnpm init adonisjs -- --kit=\"github:github_user/repo#v1.0.0\"\n```\n\n### `--token` (Default: undefined)\n\nIf you are using a custom starter kit hosted on a private repository, then you can pass the authentication token as follows:\n\n```sh\nnpm init adonisjs -- --kit=\"github:github_user/repo\" --token=\"github_token\"\n```\n\n### `--pkg` (Default: Auto detects)\n\nWe are trying to detect the package manager used by your project. However, if you want to force a specific package manager, then you can pass it as follows:\n\n```sh\nnpm init adonisjs -- --pkg=\"yarn\"\n```\n\n### `--auth-guard` (Default: Triggers prompt for selection)\n\nSpecify a custom auth guard to use when using the `api` stater kit. One of the following options are allowed\n\n- `session`\n- `access_tokens`\n\n```sh\nnpm init adonisjs -- --kit=\"api\" --auth-guard=\"access_tokens\"\n```\n\n### `--db` (Default: Triggers prompt for selection)\n\nSpecify the database dialect to configure with Lucid. One of the following options are allowd.\n\n- `sqlite`\n- `mysql`\n- `mssql`\n- `postgres`\n\n```sh\nnpm init adonisjs -- --kit=\"web\" --db=\"mysql\"\n```\n\n### Other options\n\n| Option       | Description                             |\n| ------------ | --------------------------------------- |\n| `--git-init` | Initialize git repository.              |\n| `--verbose`  | Enable verbose mode to display all logs |\n\n## Debugging errors\n\nIf creating a new project fails, then you must re-run the same command with the `--verbose` flag to view all the logs.\n\n```sh\nnpm init adonisjs -- --verbose\n```\n\n## Contributing\n\nOne of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework.\n\nWe encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework.\n\n## Code of Conduct\n\nIn order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md).\n\n## License\n\ncreate-adonisjs is open-sourced software licensed under the [MIT license](LICENSE.md).\n\n[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/create-adonisjs/test.yml?style=for-the-badge\n[gh-workflow-url]: https://github.com/adonisjs/create-adonisjs/actions/workflows/test.yml 'Github action'\n[npm-image]: https://img.shields.io/npm/v/create-adonisjs/latest.svg?style=for-the-badge\u0026logo=npm\n[npm-url]: https://www.npmjs.com/package/create-adonisjs/v/latest 'npm'\n[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge\u0026logo=typescript\n[license-url]: LICENSE.md\n[license-image]: https://img.shields.io/github/license/adonisjs/create-adonisjs?style=for-the-badge\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadonisjs%2Fcreate-adonisjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadonisjs%2Fcreate-adonisjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadonisjs%2Fcreate-adonisjs/lists"}