widgetbook_cli 3.0.0-beta.18

A CLI to interact with Widgetbook Cloud.

Overview

The CLI supports:

• uploading a Widgetbook Build
• uploading a Widgetbook Review

Quick start

# 🎯 Activate from https://pub.dev
dart pub global activate widgetbook_cli

# 🚀 Use CLI
widgetbook publish --api-key <key>

Setup

The widgetbook-cli is available as the widgetbook_cli package.

Install the CLI globally by running:

dart pub global activate widgetbook_cli

Run the CLI by using

widgetbook <command> [arguments]

Publish a Widgetbook

An existing Widgetbook can be uploaded via the publish command.

Arguments

The CLI accepts the following arguments.

Argument	Mandatory	Description
--path	➖	The path to your project. Defaults to ./.
--api-key	✅	The project specific API key for Widgetbook Cloud. See How to create an API key.
--branch	➖	The name of the branch for which the Widgetbook is uploaded. Defaults to the current git branch.
--commit	➖	The SHA hash of the commit for which the Widgetbook is uploaded. Defaults to the last commit of the current git branch.
--repository	➖	The name of the repository for which the Widgetbook is uploaded.
--actor	➖	The username of the actor which triggered the build.
--git-provider	➖	The name of the Git provider. Allowed values: GitHub, GitLab, BitBucket, Azure, Local. Defaults to Local
--base-branch	➖	The name of the pull-request's base branch.
--base-commit	➖	The SHA hash of pull-request's base branch. Defaults to the last commit of base-branch, if base-branch is set.
--pr	➖	The number of the PR on which the CLI is running.
--github-token	➖	The authentication token to post comments to the PR on which the CLI is running.

If base-branch or base-commit are omitted, a Widgetbook Build is created. If base-branch is provided, a Widgetbook Build and a Widgetbook Review is created.

Example

widgetbook publish --api-key aaabbbccc