Fleetbase CLI

FLB (Fleetbase CLI) is a command-line interface tool designed for managing Fleetbase Extensions. It simplifies the process of publishing and managing both npm and PHP Composer packages, particularly for Fleetbase extensions.

Features

• Publish Fleetbase Extensions to a specified registry.
• Unpublish Extensions from the registry.
• Automatically convert composer.json to package.json for PHP packages.
• Scaffold new Fleetbase extensions.
• Set registry token to a fleetbase instance.
• Install and Uninstall extensions.
• Flexible registry configuration.

Installation

To install FLB, run the following command:

npm install -g @fleetbase/cli

Usage

Publishing a Extension

To publish a extension, navigate to the extension directory and run:

flb publish [?path]

• [path]: (Optional) The path to the extension directory to be published. Defaults to the current directory.

For PHP only extensions, flb will automatically convert composer.json to package.json before publishing.

Unpublishing a Extension

To unpublish a extension, use:

flb unpublish [extension]

• [extension]: (Optional) The name of the extension to unpublish. If not provided, FLB will attempt to determine the extension name from the current directory.

Setup Registry Auth Token

To install purchased extensions you must setup authorization first which is linked to your Fleetbase account. You can generate a registry token at https://console.fleetbase.io/extensions/developers/credentials

To setup registry auth use:

flb set-auth [token] --path /fleetbase

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

Login to the Fleetbase Registry

Login to the Fleetbase registry. This command authenticates you with the Fleetbase registry by saving your credentials to your local .npmrc file.

flb login [options]

• -u, --username <username>: Username for the registry.
• -p, --password <password>: Password for the registry.
• -e, --email <email>: Email associated with your account.
• -r, --registry <registry>: Registry URL (default: https://registry.fleetbase.io).
• --scope <scope>: Scope for the registry (optional).
• --quotes <quotes>: Quotes option for npm-cli-login (optional).
• --config-path <configPath>: Path to the npm config file (optional).

Scaffolding a Extension

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.

To scaffold a extension, use:

flb scaffold

• -p, --path: The path to place the scaffold extension.
• -n, --name: The name of the extension to scaffold.
• -d, --description: The description of the extension to scaffold.
• -a, --author: The name of the extension author.
• -e, --email: The email of the extension author.
• -k, --keywords: The keywords of the extension to scaffold.
• -n, --namespace: The PHP Namespace of the extension to scaffold.
• -r, --repo: The Repository URL of the extension to scaffold.

Installing a Extension

To install a extension, use:

flb install [extension] --path /fleetbase

• [extension]: The name of the extension to install.
• -p, --path: (Optional) The path to the fleetbase instance directory. Defaults to the current directory.

Uninstalling a Extension

To uninstall a extension, use:

flb uninstall [extension] --path /fleetbase

• [extension]: The name of the extension to install.
• -p, --path: (Optional) The path to the fleetbase instance directory. Defaults to the current directory.

Bundling a Extension

To bundle a extension, use:

flb bundle

or to bundle and upload the created bundle, use:

flb bundle --upload

• -p, --path <path>: Path of the Fleetbase extension (default: .).
• --upload: After bundling, upload the bundle to the Fleetbase registry using your authentication token.
• --auth-token <token>: Auth token for uploading the bundle (used with --upload option).
• -r, --registry <registry>: Registry URL (default: https://registry.fleetbase.io).

Uploading a Extension Bundle

To upload an extension bundle, use:

flb bundle-upload

• [bundleFile]: Path to the bundle file to upload. If not provided, it will look for the bundle in the current directory.
• -p, --path <path>: Path where the bundle is located (default: .).
• --auth-token <token>: Auth token for uploading the bundle. If not provided, the token will be read from the .npmrc file.
• -r, --registry <registry>: Registry URL (default: https://registry.fleetbase.io).

Version Bump and Extension

To bump the version on an extension, use:

flb version-bump

• -p, --path <path>: Path of the Fleetbase extension (default: .).
• --major: Bump major version (e.g., 1.0.0 → 2.0.0).
• --minor: Bump minor version (e.g., 1.0.0 → 1.1.0).
• --patch: Bump patch version (e.g., 1.0.0 → 1.0.1). This is the default if no flag is provided.
• --pre-release [identifier]: Add a pre-release identifier (e.g., 1.0.0 → 1.0.0-beta).

Setting a Custom Registry

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

flb publish -r http://my-registry.com
flb unpublish -r http://my-registry.com

Configuration

FLB can be configured via command-line options. The most common options include:

• -r, --registry [url]: Specify a custom registry URL.

Contributing

Contributions to Fleetbase CLI are welcome. Please ensure that your code adheres to the project's coding standards and include tests for new features or bug fixes.

License & Copyright

Fleetbase is made available under the terms of the GNU Affero General Public License 3.0 (AGPL 3.0). For other licenses contact us.