itly

Iteratively CLI

• Requirements
• Usage
• Commands

Requirements

Iteratively CLI requires Node 12+

Usage

$ npm install -g @itly/itly
$ itly COMMAND
running command...
$ itly (-v|--version|version)
@itly/itly/1.1.3 darwin-x64 node-v14.12.0
$ itly --help [COMMAND]
USAGE
  $ itly COMMAND
...

Commands

• itly autocomplete [SHELL]
• itly help [COMMAND]
• itly info
• itly init
• itly pull
• itly verify
• itly export

itly autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ itly autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ itly autocomplete
  $ itly autocomplete bash
  $ itly autocomplete zsh
  $ itly autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

itly help [COMMAND]

display help for itly

USAGE
  $ itly help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

itly info

display information about the itly environment

USAGE
  $ itly info

itly init

log into Iteratively and initialize your workspace

USAGE
  $ itly init

EXAMPLE
  $ itly init

itly pull

pull down the latest tracking plan and generate a tracking library. source is required on first pull.

USAGE
  $ itly pull [<source>] [-p <path>] [-b <branch>] [-v <version>]

OPTIONS
  -b, --branch=branch    the name of the branch to pull
  -v, --version=version  the semantic version to pull
  -t, --token=token      personal API token to authenticate with
  --path=path            the path to save the generated tracking library

EXAMPLES
  $ itly pull web
  $ itly pull web -p ./itly
  $ itly pull -v 1.0.0
  $ itly pull -b develop
  $ itly pull -b main -v 4

itly verify

verify (lint) your source code for analytics

USAGE
  $ itly verify [-u] [-t <token>] [-b <branch>] [--skip-update-on-default-branch]

OPTIONS
  -t, --token=token  personal API token to authenticate with
  -u, --update       update tracking plan with latest implementation status
  -b, --branch       if set, enforces source is on provided the branch 
  --skip-update-on-default-branch
                     prevents updating implementation status on default branch. only works with `--update`

EXAMPLE
  $ itly verify
  $ itly verify -u
  $ itly verify -u -b main
  $ itly verify -u --skip-update-on-default-branch

itly export

download a tracking plan from your workspace

USAGE
  $ itly export [<source>] [-p <path>] [-t <token>]

OPTIONS
  -p, --path=path    [default: schema.json] file path to export to
  -t, --token=token  personal API token to authenticate with

EXAMPLES
  $ itly export ios
  $ itly export -p schema.json