Skip to content

Commit 1afcb97

Browse files
authored
Update README.md
1 parent 1afb7c8 commit 1afcb97

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,22 @@ flb set-auth [token] --path /fleetbase
5656

5757
- `-p, --path`: (Optional) The path to the fleetbase instance directory. Defaults to the current directory.
5858

59+
### Login to the Fleetbase Registry
60+
61+
Login to the Fleetbase registry. This command authenticates you with the Fleetbase registry by saving your credentials to your local `.npmrc` file.
62+
63+
```bash
64+
flb login [options]
65+
```
66+
67+
- `-u, --username <username>`: Username for the registry.
68+
- `-p, --password <password>`: Password for the registry.
69+
- `-e, --email <email>`: Email associated with your account.
70+
- `-r, --registry <registry>`: Registry URL (default: `https://registry.fleetbase.io`).
71+
- `--scope <scope>`: Scope for the registry (optional).
72+
- `--quotes <quotes>`: Quotes option for `npm-cli-login` (optional).
73+
- `--config-path <configPath>`: Path to the npm config file (optional).
74+
5975
### Scaffolding a Extension
6076

6177
Fleetbase CLI has the ability to scaffold a starter extension if you intend to develop your own extension. This greatly speeds up the development process as it gives you a correct starting point to build on.
@@ -97,6 +113,52 @@ flb uninstall [extension] --path /fleetbase
97113
- `[extension]`: The name of the extension to install.
98114
- `-p, --path`: (Optional) The path to the fleetbase instance directory. Defaults to the current directory.
99115

116+
### Bundling a Extension
117+
118+
To bundle a extension, use:
119+
120+
```bash
121+
flb bundle
122+
```
123+
124+
or to bundle and upload the created bundle, use:
125+
126+
```bash
127+
flb bundle --upload
128+
```
129+
130+
- `-p, --path <path>`: Path of the Fleetbase extension (default: `.`).
131+
- `--upload`: After bundling, upload the bundle to the Fleetbase registry using your authentication token.
132+
- `--auth-token <token>`: Auth token for uploading the bundle (used with `--upload` option).
133+
- `-r, --registry <registry>`: Registry URL (default: `https://registry.fleetbase.io`).
134+
135+
### Uploading a Extension Bundle
136+
137+
To upload an extension bundle, use:
138+
139+
```bash
140+
flb bundle-upload
141+
```
142+
143+
- `[bundleFile]`: Path to the bundle file to upload. If not provided, it will look for the bundle in the current directory.
144+
- `-p, --path <path>`: Path where the bundle is located (default: `.`).
145+
- `--auth-token <token>`: Auth token for uploading the bundle. If not provided, the token will be read from the `.npmrc` file.
146+
- `-r, --registry <registry>`: Registry URL (default: `https://registry.fleetbase.io`).
147+
148+
### Version Bump and Extension
149+
150+
To bump the version on an extension, use:
151+
152+
```bash
153+
flb version-bump
154+
```
155+
156+
- `-p, --path <path>`: Path of the Fleetbase extension (default: `.`).
157+
- `--major`: Bump major version (e.g., `1.0.0``2.0.0`).
158+
- `--minor`: Bump minor version (e.g., `1.0.0``1.1.0`).
159+
- `--patch`: Bump patch version (e.g., `1.0.0``1.0.1`). This is the default if no flag is provided.
160+
- `--pre-release [identifier]`: Add a pre-release identifier (e.g., `1.0.0``1.0.0-beta`).
161+
100162
### Setting a Custom Registry
101163

102164
To specify a custom registry for publishing and unpublishing, use the `-r` or `--registry` option:

0 commit comments

Comments
 (0)