Skip to content
Jux Docs
WelcomeDesignersDevelopers

CLI Reference

Usage

Terminal window
$ npm install -g @juxio/cli
$ jux COMMAND
running command...
$ jux (--version|-v|version)
@juxio/cli/0.7.0 darwin-arm64 node-v21.6.2
$ jux --help [COMMAND]
USAGE
  $ jux COMMAND
...

Commands

jux generate

Generate type definitions

Terminal window
USAGE
  $ jux generate [--cwd <value>] [-d <value>]


FLAGS
  -d, --directory=<value>  Output directory for generated files
      --cwd=<value>        The current working directory for the command


DESCRIPTION
  Generate type definitions


EXAMPLES
  $ jux generate


  $ jux generate --directory=./src/jux/types

jux generate css

Generate type definitions

Terminal window
USAGE
  $ jux generate css -o <value> [--cwd <value>]


FLAGS
  -o, --output=<value>  (required) Output file for generated CSS
      --cwd=<value>     The current working directory for the command


DESCRIPTION
  Generate type definitions


EXAMPLES
  $ jux generate css --output=./src/styles.css

jux help [COMMAND]

Display help for jux.

Terminal window
USAGE
  $ jux help [COMMAND...] [-n]


ARGUMENTS
  COMMAND...  Command to show help for.


FLAGS
  -n, --nested-commands  Include all nested commands in the output.


DESCRIPTION
  Display help for jux.

jux init

initialize your project and install dependencies

Terminal window
USAGE
  $ jux init [--cwd <value>] [-f] [-p] [--skip-deps]


FLAGS
  -f, --force        Force overwrite of existing configuration
  -p, --postcss      Whether to initialize with PostCSS
      --cwd=<value>  The directory to initialize the project in
      --skip-deps    Do not install dependencies


DESCRIPTION
  initialize your project and install dependencies


EXAMPLES
  $ jux init


  $ jux init --force

jux login

Authenticate CLI with a Jux account

Terminal window
USAGE
  $ jux login [-c <value>]


FLAGS
  -c, --cwd=<value>  The directory to initialize the project in


DESCRIPTION
  Authenticate CLI with a Jux account


EXAMPLES
  $ jux login -d

jux pull components

Pull components from Jux editor

Terminal window
USAGE
  $ jux pull components [-c <value>...] [-d <value>] [--cwd <value>]


FLAGS
  -c, --components=<value>...  Pull specific components. Separate multiple components with a space.
  -d, --directory=<value>      Output directory for generated files
      --cwd=<value>            The current working directory for the command


DESCRIPTION
  Pull components from Jux editor


EXAMPLES
  $ jux pull components -c component1 component2 component3


  $ jux pull components --all

jux pull tokens

Pull tokens from Jux editor

Terminal window
USAGE
  $ jux pull tokens [-d] [-d <value>] [-c <value>]


FLAGS
  -c, --cwd=<value>        The current working directory for the command
  -d, --definitions        Generate token definitions after pull
  -d, --directory=<value>  Output directory for generated files


DESCRIPTION
  Pull tokens from Jux editor


EXAMPLES
  $ jux pull tokens


  $ jux pull tokens -d

jux version

Terminal window
USAGE
  $ jux version [--json] [--verbose]


FLAGS
  --verbose  Show additional information about the CLI.


GLOBAL FLAGS
  --json  Format output as json.


FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.


    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.