Skip to content

Latest commit

 

History

History
221 lines (174 loc) · 9.31 KB

README.md

File metadata and controls

221 lines (174 loc) · 9.31 KB
Raw

DevCycle CLI

DevCycle CLI for interacting with DevCycle features from the command line.

Major features include:

  • Fully manage your Features, Variables, Variations and Targeting Rules from the command line
  • Detect and list DevCycle Variable usages in your codebase
  • Manage your Self-Targeting Overrides to quickly switch between Variable values
  • Generate type definitions for type-safe usage of DevCycle (Typescript only)

The CLI can be customized in several ways using command-line args or by creating a configuration file.

oclif Version License

Setup

Install the CLI

Using NPM

$ npm install -g @devcycle/cli

Or alternatively, using homebrew

$ brew tap devcyclehq/cli
$ brew install devcycle

Authentication

Many of the CLI commands require DevCycle API authorization. There are several ways to provide these credentials.

Using Access Tokens (preferred)

Login Command

By using the login sso command, the CLI will retrieve and store an access token, which is valid for 24 hours.

The login again command can be used to retrieve a new access token using the saved project and organization without prompting for them.

This process will open browser windows to interact with the DevCycle universal login page. It will first obtain a personal access token, then prompt you to choose an organization. A second browser window is used to authenticate the CLI with your chosen organization.

To switch organizations once logged in, the organizations select command can be used.

If executing the CLI in a containerized environment, please ensure one of the following PORTs can be accessed via Port Forwarding: 2194 (default), 2195, 2196 or 8080. This will allow the authentication process to complete and set the access token appropriately.

Repo Init Command

The repo init command behaves in the same way as login sso, but creates a repo configuration file and stores the project and organization choices there instead.

Using Client Credentials

Client Credentials in Auth File

Use the dvc status command to find the configuration file location for your platform. The credentials can be stored in the file pointed to by the Auth config path. Create the file if it does not exist, with the following contents.

clientCredentials:
  client_id: <your client id>
  client_secret: <your client secret>

This file should not be checked in to version control.

The default location is based on the oclif configDir

If you intend to run the CLI using options that override config file locations, the dvc status command command can be run with those options to confirm that the file locations are as expected.

Project Selection

You also need to specify the default project ID for the CLI to use.

If there is a repo configuration file, the dvc diff and dvc usages commands will use the project defined there.

Otherwise, this is chosen during login or set using the project select command

Environment Variables

Set the following environment variables:

$ export DEVCYCLE_CLIENT_ID=<your client id>
$ export DEVCYCLE_CLIENT_SECRET=<your client secret>
$ export DEVCYCLE_PROJECT_KEY=<your project key>

Command-Line Arguments

The CLI can be run with the following arguments:

$ dvc --client-id=<your client id> --client-secret=<your client secret> --project=<your project key>

Github Action

The Devcycle Github actions are configured with auth information through the project-key, client-id and client-secret configuration parameters. This is passed to the CLI via command line arguments.

Usage

$ npm install -g @devcycle/cli
$ dvc COMMAND
running command...
$ dvc (--version)
@devcycle/cli/5.20.1 linux-x64 node-v20.10.0
$ dvc --help [COMMAND]
USAGE
  $ dvc COMMAND
...

Command Topics

  • dvc alias - Manage repository variable aliases.
  • dvc autocomplete - display autocomplete installation instructions
  • dvc cleanup - Replace a DevCycle variable with a static value in the current version of your code. Currently only JavaScript is supported.
  • dvc diff - Print a diff of DevCycle variable usage between two versions of your code.
  • dvc environments - Create a new Environment for an existing Feature.
  • dvc features - Create, view, or modify Features with the Management API.
  • dvc generate - Generate Devcycle related files.
  • dvc help - Display help for dvc.
  • dvc identity - View or manage your DevCycle Identity.
  • dvc keys - Retrieve SDK keys from the Management API.
  • dvc login - Log in to DevCycle.
  • dvc logout - Discards any auth configuration that has been stored in the auth configuration file.
  • dvc organizations - List or switch organizations.
  • dvc overrides - Create, view, or modify Overrides for a Project with the Management API.
  • dvc projects - Create, or view Projects with the Management API.
  • dvc repo - Manage repository configuration.
  • dvc status - Check CLI status.
  • dvc targeting - Create, view, or modify Targeting Rules for a Feature with the Management API.
  • dvc usages - Print all DevCycle variable usages in the current version of your code.
  • dvc variables - Create, view, or modify Variables with the Management API.
  • dvc variations - Create a new Variation for an existing Feature.

Repo Configuration

The following commands can only be run from the root of a configured repository

Many of the options available as command-line args can also be specified using a repo configuration file. The default location for this file is <REPO ROOT>/.devcycle/config.yml.

This location can be overridden using the --repo-config-path flag.

The configuration file format is documented below:

## the project and organization to use when connecting to the DevCycle Rest API for this repo
project: "project-key"
org:
  id: "org_xxxxxx"
  name: "unique-org-key"
  display_name: "Human Readable Org Name"
## block for configuring "code insights" features like diff and variable usage scanning
## use this section to improve the detection of DevCycle usage within your code
codeInsights:
  ## add additional names to check for when looking for instances of DVCClient from an SDK
  clientNames:
    - "dvcClient"
  ## map the values used in your code to the corresponding variable key in DevCycle
  variableAliases:
    "VARIABLES.ENABLE_V1": "enable-v1"
  ## additional regex patterns used to match variables for a specific file extension
  matchPatterns:
    ## file extension to override for, containing a list of patterns to use
    js:
      - dvcClient\.variable\(\s*["']([^"']*)["']
  ## an array of file glob patterns to include in usage scan
  includeFiles:
    - "*.[jt]s"
  ## an array of file glob patterns to exclude from usage scan
  excludeFiles:
    - "dist/*"

Match Patterns

When identifying variable usages in the code, the CLI will identify DevCycle SDK methods by default. To capture other usages you may define match patterns. Match patterns are defined by file extension, and each pattern should contain exactly one capture group which matches the key of the variable. Make sure the captured value contains the entire key parameter (including quotes, if applicable).

Match patterns can be defined in the configuration file, for example:

codeInsights:
  matchPatterns:
    js:
      - customVariableGetter\(\s*["']([^"']*)["']
    ts:
      - customVariableGetter\(\s*["']([^"']*)["']
    jsx:
      - customVariableHook\(\s*["']([^"']*)["']
      - customVariableGetter\(\s*["']([^"']*)["']
    tsx:
      - customVariableHook\(\s*["']([^"']*)["']
      - customVariableGetter\(\s*["']([^"']*)["']

Match patterns can also be passed directly to relevant commands using the --match-pattern flag:

dvc usages --match-pattern ts="customVariableGetter\(\s*[\"']([^\"']*)[\"']" js="customVariableGetter\(\s*[\"']([^\"']*)[\"']"

When testing your regex the --show-regex flag can be helpful. This will print all patterns used to find matches in your codebase.

dvc usages --show-regex