@setkit/cli

CLI tool for interacting with Setkit.

Usage no npm install needed!

<script type="module">
  import setkitCli from 'https://cdn.skypack.dev/@setkit/cli';
</script>

README

@setkit/cli

CLI tool for interacting with Setkit.

oclif Version Downloads/week License

Usage

$ npm install -g @setkit/cli
$ setkit COMMAND
running command...
$ setkit (-v|--version|version)
@setkit/cli/0.1.1 darwin-x64 node-v13.10.1
$ setkit --help [COMMAND]
USAGE
  $ setkit COMMAND
...

Commands

setkit character:create

describe the command here

USAGE
  $ setkit character:create

OPTIONS
  -h, --help       show CLI help
  -n, --name=name  Name of new character.

See code: src/commands/character/create.ts

setkit character:link

describe the command here

USAGE
  $ setkit character:link

OPTIONS
  -h, --help  show CLI help

See code: src/commands/character/link.ts

setkit commands

list all the commands

USAGE
  $ setkit commands

OPTIONS
  -h, --help              show CLI help
  -j, --json              display unfiltered api data in json format
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --hidden                show hidden commands
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

See code: @oclif/plugin-commands

setkit help [COMMAND]

display help for setkit

USAGE
  $ setkit help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

setkit login

describe the command here

USAGE
  $ setkit login

OPTIONS
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/login.ts

setkit logout

describe the command here

USAGE
  $ setkit logout

OPTIONS
  -h, --help  show CLI help

See code: src/commands/logout.ts

setkit project

Display the active project title.

USAGE
  $ setkit project

OPTIONS
  -h, --help  show CLI help

See code: src/commands/project/index.ts

setkit project:characters

List the characters for the active project.

USAGE
  $ setkit project:characters

OPTIONS
  -h, --help  show CLI help

See code: src/commands/project/characters.ts

setkit project:create

Create a new project within active team.

USAGE
  $ setkit project:create

OPTIONS
  -h, --help         show CLI help
  -t, --title=title  Title of the new project.

See code: src/commands/project/create.ts

setkit project:list

Display the current team's project names.

USAGE
  $ setkit project:list

OPTIONS
  -h, --help  show CLI help

See code: src/commands/project/list.ts

setkit project:set

Set the active team.

USAGE
  $ setkit project:set

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/project/set.ts

setkit scene

describe the command here

USAGE
  $ setkit scene

OPTIONS
  -h, --help  show CLI help

See code: src/commands/scene/index.ts

setkit scene:characters

describe the command here

USAGE
  $ setkit scene:characters

OPTIONS
  -h, --help  show CLI help

See code: src/commands/scene/characters.ts

setkit scene:create

describe the command here

USAGE
  $ setkit scene:create

OPTIONS
  -h, --help               show CLI help
  -l, --location=location  Location of new scene
  -s, --setting=setting    Setting of new scene.
  -t, --tod=tod            Time of day of the scene

See code: src/commands/scene/create.ts

setkit scene:list

describe the command here

USAGE
  $ setkit scene:list

OPTIONS
  -h, --help  show CLI help

See code: src/commands/scene/list.ts

setkit scene:set

describe the command here

USAGE
  $ setkit scene:set

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/scene/set.ts

setkit team

Display the active team name.

USAGE
  $ setkit team

OPTIONS
  -h, --help  show CLI help

See code: src/commands/team/index.ts

setkit team:create

Create a new team.

USAGE
  $ setkit team:create

OPTIONS
  -h, --help       show CLI help
  -n, --name=name  Name of new team.

See code: src/commands/team/create.ts

setkit team:list

Display the current user's team names.

USAGE
  $ setkit team:list

OPTIONS
  -f, --filter=filter  Filter list with provided text.
  -h, --help           show CLI help
  -s, --sort=sort      Sort list by provided field.

See code: src/commands/team/list.ts

setkit team:set

Set the active team.

USAGE
  $ setkit team:set

OPTIONS
  -h, --help  show CLI help

See code: src/commands/team/set.ts