@octaviaflow/cli

Task automation for working with the OctaviaFlow Design System

Getting started

To install @octaviaflow/cli in your project, you will need to run the following command using npm:

npm install -S @octaviaflow/cli

If you prefer Yarn, use the following command instead:

yarn add @octaviaflow/cli

Usage

You can install @octaviaflow/cli in your project, or use a tool like npx by running the following command in your project:

npx @octaviaflow/cli --help

Generate IDs

You can generate different types of IDs using the generate command:

npx @octaviaflow/cli generate --id

This will output:

• UUID v4 (universally unique identifier)
• MongoDB ObjectId (for MongoDB documents)
• NanoID (URL-safe unique string identifier)

The output of the --help option is:

Usage: @octaviaflow/cli [options]

Commands:
  cli ci-check              run CI checks
  cli contribute <command>  get started contributing with OctaviaFlow
  cli generate              generate various utilities and identifiers
  cli publish <tag>         publish packages that have different versions from
                            the package registry
  cli release [bump]        run the release step for the given version bump
  cli sync [target]         sync files across workspaces

Options:
  --help     Show help                                                 [boolean]
  --version  Show version number                                       [boolean]

🙌 Contributing

We're always looking for contributors to help us fix bugs, build new features, or help us improve the project documentation. If you're interested, definitely check out our Contributing Guide! 👀

📝 License

Licensed under the Apache 2.0 License.

OctaviaFlow Telemetry

This package uses OctaviaFlow Telemetry to collect de-identified and anonymized metrics data. By installing this package as a dependency you are agreeing to telemetry collection.