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
{{ message }}
Repository navigation
Commit 1093119
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: README.md
+19-1Lines changed: 19 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -75,6 +75,8 @@ The downloaded binary is named `{tool}_{version}-{os}_{arch}`, for example:
75
75
|`--username`|`-u`| Registry username |
76
76
|`--password`|`-p`| Registry password |
77
77
|`--verbose`|`-v`| Enable verbose logging |
78
+
|`--catalog-url`|| URL of the tools catalog YAML (defaults to the catalog on this repository's `main` branch) |
79
+
|`--catalog-file`|| Path to a local tools catalog YAML, instead of fetching `--catalog-url`|
78
80
79
81
#### `get` command
80
82
@@ -88,7 +90,7 @@ The downloaded binary is named `{tool}_{version}-{os}_{arch}`, for example:
88
90
89
91
## Adding Tools
90
92
91
-
Tools are defined in [`internal/tools/tools.yaml`](internal/tools/tools.yaml) and embedded into the binary at build time. To add a new tool, append an entry and rebuild:
93
+
Tools are defined in [`internal/tools/tools.yaml`](internal/tools/tools.yaml), which is fetched at runtime from the `main` branch of this repository. To add a new tool, append an entry and open a pull request:
92
94
93
95
```yaml
94
96
my-tool:
@@ -118,6 +120,22 @@ my-tool:
118
120
119
121
The tag pulled from the registry is constructed as `{tag}-{os}_{arch}`, e.g. `latest-cli-linux_amd64`.
120
122
123
+
### Using a Custom Catalog
124
+
125
+
Both commands accept an alternative catalog, which is useful for testing an entry before it is merged, or for running fully offline:
126
+
127
+
```bash
128
+
# Local file
129
+
kubermatic-ee-downloader list --catalog-file internal/tools/tools.yaml
130
+
kubermatic-ee-downloader get my-tool --catalog-file ./my-catalog.yaml
0 commit comments