Skip to content

Commit 5ff072b

Browse files
committed
Add documentation for new commands
1 parent 1644ea2 commit 5ff072b

6 files changed

Lines changed: 53 additions & 1 deletion

File tree

docs/docs/cli/add.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ Usage:
99
devspace add [command]
1010

1111
Available Commands:
12+
package Add a helm chart
1213
port Lists port forwarding configuration
1314
sync Add a sync path to the devspace
1415

docs/docs/cli/add_package.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: devspace add package
3+
---
4+
5+
With `devspace add package`, you can easily add a package (helm chart) like mysql, nginx etc. to your devspace. To view all available packages run `devspace add package`.
6+
7+
The devspace add package command adds the helm chart as a dependency in the requirements.yaml and calls the internal `helm dependency update`, which downloads the chart and places it in the chart/charts folder. To remove the dependency call `devspace remove package PACKAGE`.
8+
9+
By default the standard stable helm chart repository is used (see: [Helm Charts](https://github.com/helm/charts/tree/master/stable)). If you want to add additional charts, just add the repository via `helm repo add` ([documentation](https://docs.helm.sh/helm/#helm-repo-add)).
10+
11+
```
12+
Usage:
13+
devspace add package [flags]
14+
15+
Flags:
16+
--app-version string App version
17+
--chart-version string Chart version
18+
-h, --help help for package
19+
--skip-question Skips the question to show the readme in a browser
20+
21+
Examples:
22+
devspace add package # Shows all available packages
23+
devspace add package mysql # Adds the mysql chart to the devspace
24+
devspace add package mysql --app-version=5.7.14 # Adds the mysql chart with app version 5.7.14 to the devspace
25+
devspace add package mysql --chart-version=0.10.3 # Adds the mysql chart with chart version 0.10.3 to the devspace
26+
```

docs/docs/cli/list.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,21 @@ title: devspace list
44

55
The command lists the following configurations:
66

7+
* Installed Packages/Charts (package)
78
* Sync paths (sync)
89
* Forwarded ports (port)
910

10-
```bash
11+
```
1112
Usage:
1213
devspace list [command]
1314
1415
Available Commands:
16+
package Lists all added packages
1517
port Lists port forwarding configuration
1618
sync Lists sync configuration
1719
1820
Flags:
1921
-h, --help help for list
22+
23+
Use "devspace list [command] --help" for more information about a command.
2024
```

docs/docs/cli/remove.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,12 @@ Usage:
99
devspace remove [command]
1010

1111
Available Commands:
12+
package Removes forwarded ports from a devspace
1213
port Removes forwarded ports from a devspace
1314
sync Remove sync paths from the devspace
1415

1516
Flags:
1617
-h, --help help for remove
18+
19+
Use "devspace remove [command] --help" for more information about a command.
1720
```

docs/docs/cli/remove_package.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: devspace remove package
3+
---
4+
5+
With `devspace remove package`, you can remove a package from the devspace.
6+
7+
`devspace remove package` deletes the specified packagename from the chart/requirements.yaml and executes the internal `helm dependency update` function.
8+
9+
```
10+
Usage:
11+
devspace remove package [flags]
12+
13+
Flags:
14+
--all Remove all packages
15+
-h, --help help for package
16+
```

docs/website/sidebars.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414
"cli/down",
1515
"cli/reset",
1616
"cli/add",
17+
"cli/add_package",
1718
"cli/remove",
19+
"cli/remove_package",
1820
"cli/install",
1921
"cli/upgrade",
2022
"cli/list",

0 commit comments

Comments
 (0)