@prisma/cli 8.0.0-rc.3-dev.54 → 8.0.0-rc.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -8,28 +8,24 @@
8
8
  [![license](https://img.shields.io/npm/l/@prisma/cli)](https://github.com/prisma/prisma-cli/blob/main/LICENSE)
9
9
  [![Node.js](https://img.shields.io/node/v/@prisma/cli)](https://www.npmjs.com/package/@prisma/cli)
10
10
 
11
- [Quickstart](#quickstart) • [Commands](#commands) • [Beta notes](#beta-notes) • [Documentation](#documentation) • [Support](#support)
11
+ [Quickstart](#quickstart) • [Commands](#commands) • [Release candidate notes](#release-candidate-notes) • [Documentation](#documentation) • [Support](#support)
12
12
 
13
13
  ---
14
14
 
15
- `@prisma/cli` is the public beta of the new CLI for the
15
+ `@prisma/cli` is the release candidate of the new CLI for the
16
16
  Prisma Developer Platform.
17
17
 
18
- It is the terminal surface managing your platform projects, branches, apps,
19
- deployments, and environment variables.
18
+ It is one binary for the ORM, Composer, and the Prisma Developer
19
+ Platform: projects, branches, services, service versions, environment
20
+ variables, and the Prisma ORM schema and migration workflow.
20
21
 
21
- The command model is under active development to include tooling for your
22
- schema, database, migration, and broader platform workflows.
23
-
24
- Looking for Prisma ORM commands such as `prisma generate`, `prisma migrate`, or
25
- `prisma studio`? Use the [`prisma`](https://www.npmjs.com/package/prisma)
26
- package.
22
+ Prisma also runs [Prisma Postgres](https://www.prisma.io/postgres) (managed Postgres) and [Prisma Compute](https://www.prisma.io/compute) (app hosting).
27
23
 
28
24
  ---
29
25
 
30
26
  ## Quickstart
31
27
 
32
- Install the beta package locally:
28
+ Install the package locally:
33
29
 
34
30
  ```bash
35
31
  npm install --save-dev @prisma/cli
@@ -40,29 +36,32 @@ Run the binary exposed by this package:
40
36
  ```bash
41
37
  npx prisma-cli --help
42
38
  npx prisma-cli auth login
43
- npx prisma-cli app deploy
39
+ npx prisma-cli project create my-app
40
+ npx prisma-cli git connect git@github.com:owner/repo.git
44
41
  ```
45
42
 
43
+ Deployments start from pushing the connected repository, the Console, or `prisma-cli deploy`.
44
+
46
45
  With `pnpm`:
47
46
 
48
47
  ```bash
49
48
  pnpm add -D @prisma/cli
50
49
  pnpm prisma-cli auth login
51
- pnpm prisma-cli app deploy
50
+ pnpm prisma-cli git connect
52
51
  ```
53
52
 
54
53
  Useful next commands:
55
54
 
56
55
  ```bash
57
- npx prisma-cli app logs
58
- npx prisma-cli app open
56
+ npx prisma-cli service list
57
+ npx prisma-cli service logs
59
58
  npx prisma-cli project env add DATABASE_URL=postgresql://example --role preview
60
59
  npx prisma-cli project env add --file .env --role preview
61
60
  npx prisma-cli project env list
62
61
  npx prisma-cli project env list --role preview
63
62
  ```
64
63
 
65
- The beta package exposes `prisma-cli` so it can coexist with the existing
64
+ This package exposes `prisma-cli` so it can coexist with the existing
66
65
  `prisma` executable.
67
66
 
68
67
  ---
@@ -71,24 +70,26 @@ The beta package exposes `prisma-cli` so it can coexist with the existing
71
70
 
72
71
  | Group | What it does |
73
72
  | --- | --- |
74
- | `version` | Show the installed CLI build and host environment. |
75
73
  | `auth` | Log in, log out, and inspect the active Prisma account. |
76
- | `project` | List projects, show the resolved project, and manage project environment variables. |
77
- | `git` | Connect or disconnect a project from a GitHub repository. |
74
+ | `project` | List, create, link, and manage projects and their environment variables. |
75
+ | `git` | Connect or disconnect a project from a GitHub repository; pushes deploy. |
78
76
  | `branch` | List Prisma branches for the resolved project. |
79
- | `database` | Create, inspect, and remove Prisma Postgres databases and their connection strings. |
80
- | `bucket` | Create, list, and delete Tigris object-store buckets and their access keys. |
81
- | `app` | Build, run, deploy, inspect, open, stream logs, promote, roll back, and remove apps. |
77
+ | `postgres` | Create, inspect, back up, restore, and delete Prisma Postgres databases and their connections. |
78
+ | `bucket` | Create, list, and delete object-store buckets and their access keys. |
79
+ | `service` | Inspect services: versions, logs, domains, promote, roll back, delete. |
80
+ | `dev`, `deploy` | Run a Composer app locally; deploy it to the platform. `dev url` prints a running node's local URL and `dev stop` stops the app. |
81
+ | `emulator` | List the local emulators `prisma dev` runs services, databases and buckets on. |
82
+ | `contract`, `db`, `migration`, `orm init`, `lsp` | The Prisma ORM workflow. |
82
83
 
83
84
  Common examples:
84
85
 
85
86
  ```bash
86
- npx prisma-cli version
87
+ npx prisma-cli --version
87
88
  npx prisma-cli auth whoami
88
89
  npx prisma-cli project show
89
90
  npx prisma-cli branch list
90
- npx prisma-cli app deploy --branch feat-login --framework nextjs
91
- npx prisma-cli app promote <deployment-id>
91
+ npx prisma-cli service list
92
+ npx prisma-cli service version promote VERSION_ID
92
93
  ```
93
94
 
94
95
  ### Built for humans, CI, and agents
@@ -102,12 +103,12 @@ npx prisma-cli app promote <deployment-id>
102
103
 
103
104
  ---
104
105
 
105
- ## Beta notes
106
+ ## Release candidate notes
106
107
 
107
- - Requires Node.js 22.18 or newer.
108
- - This is a beta package and may change quickly.
109
- - Official beta releases publish as `@prisma/cli`.
110
- - The package binary is `prisma-cli`, not `prisma`, during beta.
108
+ - Requires Node.js 22.18 or newer on the 22 line, 24.11 or newer on the 24 line, or 26 or newer.
109
+ - This is a release-candidate package and may change quickly.
110
+ - The 8.0.0 release candidates publish as `@prisma/cli` on the `latest` dist-tag.
111
+ - The package binary is `prisma-cli`; the sibling `prisma` package ships the same CLI under the `prisma` binary.
111
112
  - Local project context is cached in `.prisma/local.json`, which is gitignored and not a declarative repo config file.
112
113
 
113
114
  ---
@@ -115,17 +116,23 @@ npx prisma-cli app promote <deployment-id>
115
116
  ## Documentation
116
117
 
117
118
  - [CLI docs index](https://github.com/prisma/prisma-cli/blob/main/docs/README.md)
118
- - [Resource model](https://github.com/prisma/prisma-cli/blob/main/docs/product/resource-model.md)
119
119
  - [Command principles](https://github.com/prisma/prisma-cli/blob/main/docs/product/command-principles.md)
120
- - [Command spec](https://github.com/prisma/prisma-cli/blob/main/docs/product/command-spec.md)
121
120
  - [Output conventions](https://github.com/prisma/prisma-cli/blob/main/docs/product/output-conventions.md)
122
121
  - [Error conventions](https://github.com/prisma/prisma-cli/blob/main/docs/product/error-conventions.md)
123
122
 
124
123
  ## Support
125
124
 
126
- Issues and feedback are welcome while the CLI is in public beta. Please use
127
- [GitHub issues](https://github.com/prisma/prisma-cli/issues) for bug reports and
128
- feature requests.
125
+ Send a bug report or feature request directly from your terminal:
126
+
127
+ ```bash
128
+ npx @prisma/cli@latest feedback "Describe what happened and what you expected"
129
+ ```
130
+
131
+ Feedback is anonymous by default. Add `--email you@example.com` if you want a
132
+ reply. Submissions include your message, CLI and runtime versions, OS platform,
133
+ and architecture. Review your message for secrets before sending.
134
+
135
+ For a public discussion, use [GitHub issues](https://github.com/prisma/prisma-cli/issues).
129
136
 
130
137
  Security reports should follow Prisma's
131
138
  [security policy](https://github.com/prisma/prisma-cli/blob/main/SECURITY.md)