labels cli (#208)

ploomber · Apr 26, 2024 · e13af62 · e13af62
1 parent a1e9fd9
commit e13af62
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/doc/static/labels.png b/doc/static/labels.png
diff --git a/doc/user-guide/cli.md b/doc/user-guide/cli.md
@@ -237,4 +237,53 @@ You can easily reconfigure them with:
 
 ```sh
 ploomber-cloud resources --force
+```
+
+## Add labels
+
+You can add labels to your project by running: 
+
+```sh 
+ploomber-cloud labels --add label_1 -a label_2
+```
+
+The labels will be added to the `ploomber-cloud.json` file like so:
+
+```json
+{
+    "id": "broken-night-1393",
+    "type": "dash",
+    "labels": [
+        "dash",
+        "simple"
+    ]
+}
+```
+
+Labels can be added either after `ploomber-cloud init` or `ploomber-cloud deploy`. Once the project is deployed the labels will reflect in the UI:
+
+![](../static/labels.png)
+
+When you initialize a project using `--force`, the labels already configured will be carried over.
+
+### Delete labels
+
+To delete a label you can run:
+
+```sh 
+ploomber-cloud labels --delete label_1 -d label_2
+```
+
+You can also add and delete labels at the same time:
+
+```sh 
+ploomber-cloud labels --add label_1 --delete label_2
+```
+
+### View labels
+
+To view all labels added to your project simply run:
+
+```sh 
+ploomber-cloud labels
 ```