Skip to content

Commit e197312

Browse files
authored
document include feature (#322)
1 parent 6e94104 commit e197312

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

doc/user-guide/cli.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -552,3 +552,34 @@ To start Dev Mode, run from your project folder:
552552
```sh
553553
ploomber-cloud dev
554554
```
555+
556+
## Explicitly include files
557+
558+
```{versionadded} 0.4.5
559+
```
560+
561+
By default, `ploomber-cloud` ignores certain files when deploying your app (e.g. `.git` or `.pyc`).
562+
563+
If you want to make sure certain files are **not** ignored, you can specify them in the `include` config field.
564+
565+
You'll need to generate your config file using:
566+
567+
```sh
568+
ploomber-cloud init
569+
```
570+
571+
Next, add the `include` field to the generated `ploomber-cloud.json`:
572+
573+
```json
574+
{
575+
"id": "mute-mouse-4739",
576+
"type": "streamlit",
577+
"include": [
578+
".git"
579+
]
580+
}
581+
```
582+
583+
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.
584+
585+

0 commit comments

Comments
 (0)