From 8672fd12c3c46e0c37485b499168ccf1e519b5b4 Mon Sep 17 00:00:00 2001 From: Bryan Ho Date: Wed, 30 Jul 2025 08:48:58 -0700 Subject: [PATCH] document include feature --- doc/user-guide/cli.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/doc/user-guide/cli.md b/doc/user-guide/cli.md index 101884f4..99181777 100644 --- a/doc/user-guide/cli.md +++ b/doc/user-guide/cli.md @@ -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. + +