Skip to content

[Doc] CLI dev mode docs added #311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
edublancas merged 2 commits into from
Mar 5, 2025
Merged

[Doc] CLI dev mode docs added #311

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d3317b
dev docs
yafimvo Mar 5, 2025
08fd6e5
fix
yafimvo Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions doc/user-guide/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,3 +536,19 @@ Where `PROJECT_ID` is the randomly generated ID. If you did not set a custom nam
the `PROJECT_ID` is the string in the URL (either `PROJECT_ID.ploomber.app` or `PROJECT_ID.ploomberapp.io`), if you set
a custom name, you can retrieve the `PROJECT_ID` by clicking on the ⚙️ icon next to the
URL in your app detailed view.


## Dev mode

```{versionadded} 0.4.2
```

Enable live dev mode for automatic deployment on source changes. When you save a file, the CLI uploads the modified file, and you can see the changes at `<project-id>.ploomber.app`.

If you modify `requirements.txt`, the CLI installs the new dependencies and restarts the app automatically.

To start Dev Mode, run from your project folder:

```sh
ploomber-cloud dev
```