{"id":19683865,"url":"https://github.com/prisma/try-prisma","last_synced_at":"2025-04-07T12:07:10.998Z","repository":{"id":64208575,"uuid":"525616515","full_name":"prisma/try-prisma","owner":"prisma","description":null,"archived":false,"fork":false,"pushed_at":"2025-03-06T12:46:37.000Z","size":21521,"stargazers_count":47,"open_issues_count":2,"forks_count":1,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-03-31T10:11:15.368Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prisma.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2022-08-17T02:50:29.000Z","updated_at":"2025-03-06T12:46:02.000Z","dependencies_parsed_at":"2023-12-28T19:32:12.616Z","dependency_job_id":"268b70de-f349-44f8-bca8-2a3367b97aba","html_url":"https://github.com/prisma/try-prisma","commit_stats":null,"previous_names":[],"tags_count":63,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prisma%2Ftry-prisma","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prisma%2Ftry-prisma/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prisma%2Ftry-prisma/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prisma%2Ftry-prisma/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prisma","download_url":"https://codeload.github.com/prisma/try-prisma/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247648977,"owners_count":20972945,"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":[],"created_at":"2024-11-11T18:15:52.409Z","updated_at":"2025-04-07T12:07:10.973Z","avatar_url":"https://github.com/prisma.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=center\u003e\n\n![readme-try-prisma](https://user-images.githubusercontent.com/18456526/202004157-e7c97399-1669-4d80-899c-537e09758214.png)\n\n[![Tests](https://github.com/prisma/try-prisma/actions/workflows/test.yml/badge.svg)](https://github.com/prisma/try-prisma/actions/workflows/test.yml)\n[![Linting](https://github.com/prisma/try-prisma/actions/workflows/lint.yml/badge.svg)](https://github.com/prisma/try-prisma/actions/workflows/lint.yml)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n\n\u003c/div\u003e\n\n`try-prisma` is a CLI tool that helps you easily get up and running with any project from the [`prisma/prisma-examples`](https://github.com/prisma/prisma-examples) repository.\n\nThese projects are meant to be playgrounds for you to test integrations and features, _not production-ready boilerplates or templates_.\n\n\u003e Do you have feedback about a specific example template? Submit it [here](https://pris.ly/prisma-examples-feedback)!\n\n## Usage\n\nThe easiest way to set up a project using `try-prisma` is to run the following command:\n\n```sh copy\nnpx try-prisma\n```\n\nThis will walk you through a set of interactive options _(detailed below)_ to help you set up your project.\n\n## Arguments\n\nYou can _optionally_ provide arguments to the `npx try-prisma` command as an alternative to (or in combination with) the interactive experience.\n\nThe options are as follows:\n\n|      Option      | Alias |      Arguments       |            Default            | Description                                                                                                                                                                                                                                  |\n|------------------|-------|----------------------|--------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `--install`      | -i    | Boolean             | `false`                        | Specifies if you would like to install npm packages automatically after creating the project. You can also specify which package manager to use: `npm`, `yarn`, or `pnpm`.                                                                   |\n| `--name`         | -n    |                      | Name of the selected template | Defines the name of the resulting directory.                                                                                                                                                                                                 |\n| `--template`     | -t    |                      | n/a                            | Specifies which example project you would like to start off with.                                                                                                                                                                            |\n| `--database-url` | -d    |                      | n/a                            | Specifies the database URL you would like to use for the project.                                                                                                                                                                            |\n| `--vscode`       | -v    | Boolean (optional)   | `false`                        | Adds a `.vscode` folder with an `extensions.json` file suggesting the [Prisma VS Code extension](https://marketplace.visualstudio.com/items?itemName=Prisma.prisma).                                                                         |\n\n## Examples\n\n### Selecting a template and installing packages\n\nYou would like to use the template named `orm/grpc`, and install packages automatically:\n\n```sh\nnpx try-prisma -t orm/grpc --install\n```\n\nIn this scenario, you will still be prompted to input values for your preferred package manager and the name of the resulting folder.\n\n### Selecting a package manager\n\nIf you wanted to use [`yarn`](https://yarnpkg.com/) to install the packages automatically:\n\n```sh\nnpx try-prisma -i yarn\n```\n\n### Selecting a folder name\n\nYou can create a new project in the current directory by executing the following:\n\n```sh\nnpx try-prisma -n new_folder\n```\n\n### All of the options!\n\nInteractive terminal who?? Use all the options!\n\n```npx\nnpx try-prisma -t orm/grpc -i pnpm -n my_project\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprisma%2Ftry-prisma","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprisma%2Ftry-prisma","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprisma%2Ftry-prisma/lists"}