You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[Feature] Documentation on the --config flag when using init (#287)
* [Feature] Documentation on the `--config` flag when using `ploomber-cloud init`
* fix: typo
* [Feature] Documentation on `--config` sub dir in `swtiching the config file section
* chore: wrong rendering of `warning`
* chore: simple `Refer to this section` to configure project
* Update doc/user-guide/cli.md
When deploying from the terminal, it's recommended to use the `--watch` option. This flag clears the terminal before printing updated logs, ensuring a clean display. Alternatively, if you're storing deployment output in a file, such as with GitHub Actions, opt for `--watch-incremental`. This option skips clearing the screen and only prints new logs and status updates.
55
55
56
+
57
+
(config)=
56
58
## Configure an existing project
57
59
58
-
If you want to deploy an existing project, run the `init` command with the `--from-existing` flag:
60
+
If you want to deploy an existing project, run the `init` command with the `--from-existing` flag to download this one:
59
61
60
62
```sh
61
63
ploomber-cloud init --from-existing
@@ -88,6 +90,14 @@ Then, execute:
88
90
ploomber-cloud deploy
89
91
```
90
92
93
+
**Optional Configuration**:
94
+
You can use the `--config` flag with the `ploomber-cloud init --from-existing` command to specify a custom name for the configuration file instead of the default `ploomber-cloud.json`. When using this flag for downloading your project, only the file name will be considered, regardless of any specified path. For example:
This will generate only the ploomber-cloud.json file in your current directory, without creating a new project directory or downloading the project files.
99
109
110
+
111
+
**Optional Configuration**:
112
+
You can use the `--config` flag in combination with `--only-config` to specify a custom name and location for the configuration file:
This allows you to choose a different name for the configuration file and the specify a different location to save the file.
117
+
100
118
## Force initialize an app
101
119
102
120
You might want to re-initialize your project in case the `ploomber-cloud.json` file has got corrupted or doesn't contain the valid keys.
@@ -428,7 +446,7 @@ ploomber-cloud labels --sync
428
446
429
447
By default, the CLI reads and writes to a `ploomber-cloud.json` file, but you can customize it via the `--config` (or its short version, `-c`), switching the config file is useful when you need to manage multiple environments (for example, development and production).
430
448
431
-
All commands that read or write the config file accept the `--config/-c` argument, for example:
449
+
All commands that read or write the config file accept the `--config/-c` argument. You can use this option to specify both alternative file names and paths, for example:
432
450
433
451
```sh
434
452
# create the config file in ploomber-cloud.dev.json
0 commit comments