Cloud CLI documentation #2086
Cloud CLI documentation #2086
Conversation
meganelacheny
commented
Apr 17, 2024
•
meganelacheny
commented
- Create Cloud CLI section in Cloud documentation TOC
- Document Cloud CLI in dedicated page
- Update deployment guide in Cloud docs
- Create deployment guide specifically for CLI
meganelacheny
added
flag: merge pending release
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
Co-authored-by: Pierre Wizla <pwizla@users.noreply.github.com>
|
|
||
| Strapi Cloud comes with a Command Line Interface (CLI) which allows you to log in and out, and to deploy a project that is not hosted on a remote git repository. The CLI works with both the `yarn` and `npm` package managers. | ||
|
|
||
| The Cloud CLI is designed as a CLI-only experience, meaning that users who wish to use Strapi Cloud to deploy their project with the CLI will have to mostly stick to using the CLI (e.g. if you login with the CLI you must logout with the CLI as well, your project deployed with the CLI can only be redeployed with the CLI etc.). |
There was a problem hiding this comment.
ℹ️ It's only true for the first version of the CLI. We will need to change this line once we release the next iteration 🤞
|
|
||
| **Alias:** `strapi cloud:deploy` | ||
|
|
||
| Deploy a new project (< 100MB), not already hosted on a remote git repository, in Strapi Cloud. |
There was a problem hiding this comment.
Hosted or not, it doesn't change anything. The user will deploy the local version of his project.
There was a problem hiding this comment.
Would it make more sense to you @nathan-pichon if I change the sentence to "Deploy a new local project (< 100MB) in Strapi Cloud."? 🤔
| strapi deploy | ||
| ``` | ||
|
|
||
| This command must be used after the `login` one. It deploys a local Strapi project on Strapi Cloud, without having to host it on a remote git repository beforehand. The terminal will display a progress bar until the project is successfully deployed on Strapi Cloud. |
There was a problem hiding this comment.
The progress bar is only for uploading time, not for building time (and not for deploying time).
The deploy command work in 3 phases. First compression and upload of the project (progress bar). Then build time (user will get the logs according to the build phase). Then deploy time (user won't have the logs in CLI) that can be retrieve on Cloud Dashboard.
There was a problem hiding this comment.
Alright, I'll remove the part about the progress bar then 🤓
| Once the project is first deployed on Strapi Cloud with the CLI, the `deploy` command can be reused to trigger a new deployment of the same project. | ||
|
|
||
| :::caution | ||
| The `deploy` command can only be used by new users who have never created a Strapi Cloud project, and for which the free trial is still available. Once a project is deployed with the CLI, it isn't possible to deploy another project on the same Strapi Cloud account with the CLI. |
There was a problem hiding this comment.
ℹ️ It's only true for the first version of the CLI. 🤞
