Skip to content

CLI include option documentation #322

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 1 commit into from
Jul 30, 2025
Merged

CLI include option documentation #322

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 31 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 @@ -552,3 +552,34 @@ To start Dev Mode, run from your project folder:
```sh
ploomber-cloud dev
```

## Explicitly include files

```{versionadded} 0.4.5
```

By default, `ploomber-cloud` ignores certain files when deploying your app (e.g. `.git` or `.pyc`).

If you want to make sure certain files are **not** ignored, you can specify them in the `include` config field.

You'll need to generate your config file using:

```sh
ploomber-cloud init
```

Next, add the `include` field to the generated `ploomber-cloud.json`:

```json
{
"id": "mute-mouse-4739",
"type": "streamlit",
"include": [
".git"
]
}
```

You can specify as many files or directories you want, and this will ensure the files are **always included** in your zipped Ploomber Cloud deployment.