Skip to content

Commit fe16fb3

Browse files
Add documentation for missing CLI commands (#1303)
* Add documentation for missing CLI commands and improve deploy docs Co-Authored-By: Alek Petuskey <[email protected]> * Simplify cloud documentation with link to deploy-quick-start Co-Authored-By: Alek Petuskey <[email protected]> * Add link to deploy documentation in quickstart Co-Authored-By: Alek Petuskey <[email protected]> * Replace deploy command options with API reference link Co-Authored-By: Alek Petuskey <[email protected]> --------- Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Alek Petuskey <[email protected]> Co-authored-by: Alek Petuskey <[email protected]>
1 parent 81bc1e2 commit fe16fb3

File tree

2 files changed

+53
-12
lines changed

2 files changed

+53
-12
lines changed

docs/api-reference/cli.md

Lines changed: 49 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,21 @@ Usage: reflex [OPTIONS] COMMAND [ARGS]...
1212
Reflex CLI to create, run, and deploy apps.
1313

1414
Options:
15-
-v, --version Get the Reflex version.
16-
--help Show this message and exit.
15+
--version Show the version and exit.
16+
--help Show this message and exit.
1717

1818
Commands:
19-
db Subcommands for managing the database schema.
20-
demo Run the demo app.
21-
deploy Deploy the app to the Reflex hosting service.
22-
deployments Subcommands for managing the Deployments.
23-
export Export the app to a zip file.
24-
init Initialize a new Reflex app in the current directory.
25-
login Authenticate with Reflex hosting service.
26-
logout Log out of access to Reflex hosting service.
27-
run Run the app in the current directory.
19+
cloud The Hosting CLI.
20+
component CLI for creating custom components.
21+
db Subcommands for managing the database schema.
22+
deploy Deploy the app to the Reflex hosting service.
23+
export Export the app to a zip file.
24+
init Initialize a new Reflex app in the current directory.
25+
login Authenticate with experimental Reflex hosting service.
26+
logout Log out of access to Reflex hosting service.
27+
rename Rename the app in the current directory.
28+
run Run the app in the current directory.
29+
script Subcommands for running helper scripts.
2830
```
2931

3032
## Init
@@ -88,3 +90,39 @@ You can export your app's frontend and backend to zip files using the `reflex ex
8890
The frontend is a compiled NextJS app, which can be deployed to a static hosting service like Github Pages or Vercel.
8991
However this is just a static build, so you will need to deploy the backend separately.
9092
See the self-hosting guide for more information.
93+
94+
## Rename
95+
96+
The `reflex rename` command allows you to rename your Reflex app. This updates the app name in the configuration files.
97+
98+
```bash
99+
$ reflex rename --help
100+
Usage: reflex rename [OPTIONS] NEW_NAME
101+
102+
Rename the app in the current directory.
103+
104+
Options:
105+
--loglevel [debug|default|info|warning|error|critical]
106+
The log level to use.
107+
--help Show this message and exit.
108+
```
109+
110+
## Cloud
111+
112+
The `reflex cloud` command provides access to the Reflex Cloud hosting service. It includes subcommands for managing apps, projects, secrets, and more.
113+
114+
For detailed documentation on Reflex Cloud and deployment, see the [Cloud Quick Start Guide](https://reflex.dev/docs/hosting/deploy-quick-start/).
115+
116+
## Script
117+
118+
The `reflex script` command provides access to helper scripts for Reflex development.
119+
120+
```bash
121+
$ reflex script --help
122+
Usage: reflex script [OPTIONS] COMMAND [ARGS]...
123+
124+
Subcommands for running helper scripts.
125+
126+
Options:
127+
--help Show this message and exit.
128+
```

docs/hosting/deploy-quick-start.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,9 @@ The command is by default interactive. It asks you a few questions for informati
6363

6464
That’s it! You should receive some feedback on the progress of your deployment and in a few minutes your app should be up. 🎉
6565

66+
For detailed information about the deploy command and its options, see the [Deploy API Reference](https://reflex.dev/docs/hosting/deploy/) and the [CLI Reference](https://reflex.dev/docs/api-reference/cli/).
67+
68+
6669
```md alert info
6770
# Once your code is uploaded, the hosting service will start the deployment. After a complete upload, exiting from the command **does not** affect the deployment process. The command prints a message when you can safely close it without affecting the deployment.
6871
```
@@ -83,4 +86,4 @@ To go back, i.e. from an app to a project or from a project to your list of proj
8386
```md alert info
8487
# All flag values are saved between runs
8588
All your flag values, i.e. environment variables or regions or tokens, are saved between runs. This means that if you run a command and you pass a flag value, the next time you run the same command the flag value will be the same as the last time you ran it. This means you should only set the flag values again if you want to change them.
86-
```
89+
```

0 commit comments

Comments
 (0)