cjr

cjr is a tool for running jobs in linux containers

• Usage
• Commands

Usage

$ npm install -g cjr
$ cjr COMMAND
running command...
$ cjr (-v|--version|version)
cjr/0.5.3 linux-x64 node-v12.16.1
$ cjr --help [COMMAND]
USAGE
  $ cjr COMMAND
...

Commands

• cjr $ COMMAND
• cjr bundle BUNDLE-PATH
• cjr config:ls
• cjr config:set
• cjr help [COMMAND]
• cjr init
• cjr job:attach [ID]
• cjr job:cp [ID]
• cjr job:exec ID COMMAND
• cjr job:info [ID]
• cjr job:log [ID]
• cjr job:ls
• cjr job:rm [ID]
• cjr job:shell [ID]
• cjr job:start COMMAND
• cjr job:state ID
• cjr job:stop [ID]
• cjr jupyter:ls
• cjr jupyter:start [PROJECT-ROOT]
• cjr jupyter:stop [PROJECT-ROOT]
• cjr pconfig:item-append
• cjr pconfig:item-remove
• cjr pconfig:ls
• cjr pconfig:profile:add [PATH]
• cjr pconfig:rm
• cjr pconfig:set
• cjr resource:add RESOURCE
• cjr resource:ls
• cjr resource:rm RESOURCE
• cjr resource:set RESOURCE
• cjr resource:ssh [RESOURCE]
• cjr resource:sync:ls [RESOURCE]
• cjr resource:sync:reset [RESOURCE]
• cjr resource:sync:start [RESOURCE]
• cjr resource:sync:stop [RESOURCE]
• cjr resource:tunnel:stop [RESOURCE]
• cjr shell
• cjr stack:build [STACK]
• cjr stack:create NAME
• cjr stack:ls
• cjr stack:pull URL
• cjr stack:rmi [STACK]
• cjr stack:snapshot [STACK]
• cjr theia:ls
• cjr theia:start [PROJECT-ROOT]
• cjr theia:stop [PROJECT-ROOT]
• cjr vnc:ls
• cjr vnc:start [PROJECT-ROOT]
• cjr vnc:stop [PROJECT-ROOT]

cjr $ COMMAND

Start a job that runs a shell command.

USAGE
  $ cjr $ COMMAND

OPTIONS
  -q, --quiet
  -v, --verbose                          shows output for each stage of the job.
  --async

  --build-mode=build-mode                [default: cached] specify how to build stack. Options include "reuse-image",
                                         "cached", "no-cache", "cached,pull", and "no-cache,pull"

  --config-files=config-files            [default: ] additional configuration file to override stack configuration

  --copy                                 automatically copy files back to the project root on exit

  --explicit

  --file-access=volume|shared            [default: volume] how files are accessed from the container.

  --here                                 sets project-root to current working directory

  --label=label                          [default: ] additional labels to append to job

  --message=message                      use this flag to tag a job with a user-supplied message

  --no-autoload                          prevents cli from automatically loading flags using project settings files

  --no-copy                              do not copy files back to the project root on exit

  --port=port                            [default: ]

  --profile=profile                      set stack profile

  --project-root=project-root

  --resource=resource

  --stack=stack

  --stacks-dir=stacks-dir                override default stack directory

  --sync

  --working-directory=working-directory  [default: /home/vagrant/cjr] cli will behave as if it was called from the
                                         specified directory

  --x11

See code: src/commands/$.ts

cjr bundle BUNDLE-PATH

Bundle a stack or project into a zip or tar for sharing.

USAGE
  $ cjr bundle BUNDLE-PATH

OPTIONS
  --config-files=config-files  [default: ] additional configuration file to override stack configuration
  --config-only                only bundle project configuration
  --explicit
  --no-autoload                prevents cli from automatically loading flags using project settings files
  --project-root=project-root
  --stack=stack
  --stacks-dir=stacks-dir      override default stack directory
  --tar                        produces a tar.gz output file (requires tar)
  --verbose
  --zip                        produces a zip output file (requires zip)

See code: src/commands/bundle.ts

cjr config:ls

List all cli parameters and data directories.

USAGE
  $ cjr config:ls

OPTIONS
  --json

See code: src/commands/config/ls.ts

cjr config:set

Set one or multiple cli parameters.

USAGE
  $ cjr config:set

OPTIONS
  -q, --quiet

  --always-print-job-id=true|false                            if true, then cjr job:start command will always print the
                                                              user id even if --async flag is not selected.

  --auto-project-root=true|false                              if true, then cjr will automatically traverse up the
                                                              directory tree looking for .cjr directories where
                                                              .cjr/project-settings.yml has project-root: "auto". If it
                                                              finds such a project then it will set the default
                                                              --project-root flag to this directory.

  --auto-sync-remote-service=true|false                       enable automatic two-way syncing for remote development
                                                              commands.

  --autocopy-on-service-exit=true|false                       if true, then cjr will automatically run job:copy when
                                                              remote services like Jupyter and Theia are stopped using
                                                              the jupyter:stop and theia:stop commands.

  --autocopy-sync-job=true|false                              if true, then cjr will automatically run job:copy at the
                                                              end of all synchronous jobs.

  --container-registry=container-registry                     url of default container registry for pushing snapshots.

  --container-registry-user=container-registry-user           container registry username for pushing snapshots.

  --default-container-shell=default-container-shell           default shell that should be started for shell and
                                                              job:shell commands (e.g. sh, bash, zsh).

  --driver=podman-cli|docker-cli|docker-socket|podman-socket  container engine used to build and run images.

  --enable-remote-services=true|false                         enable the resource flag for development commands shell,
                                                              jupyter, theia, and vnc.

  --image-tag=image-tag                                       tag that cli uses when building all its images.

  --interactive=true|false                                    if true, then certain cli commands will prompt the user
                                                              with interactive menus.

  --job-default-run-mode=sync|async                           determines if new jobs run sync or async by default.

  --job-ls-fields=job-ls-fields                               specifies which fields appear when running job:list. The
                                                              string must be a comma separated list that contains any
                                                              subset of the fields "id", "stack", "stackName", "status",
                                                              "command", "message".

  --jupyter-interface=lab|notebook                            Determine if jupyter:start command should run Jupyter lab
                                                              or Jupyter notebook.

  --on-http-start=on-http-start                               command that should be run after a Jupyter or Theia server
                                                              starts.

  --on-vnc-start=on-vnc-start                                 command that should be run after a vnc server starts.

  --rootfull=true|false                                       If true, then Podman or Docker will be explicitly run as
                                                              root; for cli drivers this requires passwordless sudo for
                                                              docker and podman commands.

  --run-shortcuts-file=run-shortcuts-file                     location of a yml file that can be used to specify run
                                                              shortcuts for the cjr job:start command; To disable set
                                                              value to ''.

  --selinux=true|false                                        if true, then the :Z option will be applied to all bind
                                                              mounts.

  --socket-path=socket-path                                   location of container runtime socket.

  --stacks-dir=stacks-dir                                     the default path to a folder that contains cjr stacks.

  --timeout-jupyter=timeout-jupyter                           maximum number of seconds that cjr should wait for jupyter
                                                              server to start.

  --timeout-theia=timeout-theia                               number of seconds that cjr should wait for theia server to
                                                              start.

  --vnc-password=vnc-password                                 vnc default password

  --vnc-resolution=vnc-resolution                             vnc default resolution

  --xquartz-autostart=true|false                              only affects mac. if true, then cjr will try to start
                                                              xquartz automatically when --x11 flag is selected.

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

cjr help [COMMAND]

display help for cjr

USAGE
  $ cjr help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

cjr init

Initialize a project in the current directory.

USAGE
  $ cjr init

OPTIONS
  --project-root-auto
  --resource=resource                      default resource for project
  --stack=stack                            default stack for project
  --stacks-dir=stacks-dir                  override default stack directory for project
  --template=empty|default|project-stacks  [default: default]

  --visible-stacks=visible-stacks          if specified, only these stacks will be visible when running cjr from within
                                           this project directory.

See code: src/commands/init.ts

cjr job:attach [ID]

Attach to a running job.

USAGE
  $ cjr job:attach [ID]

OPTIONS
  --explicit
  --no-autoload                    prevents cli from automatically loading flags using project settings files
  --resource=resource
  --stacks-dir=stacks-dir          override default stack directory
  --visible-stacks=visible-stacks  if specified only these stacks will be affected by this command

See code: src/commands/job/attach.ts

cjr job:cp [ID]

Copy job files back into the host directories; works on both running and completed jobs.

USAGE
  $ cjr job:cp [ID]

OPTIONS
  -q, --quiet
  -v, --verbose                          Shows output from rsync.

  --all-files                            If selected, any include or exclude file will be ignored and all project files
                                         will be copied

  --copy-path=copy-path                  Overides job default copy path.

  --explicit

  --mode=update|overwrite|mirror|manual  [default: update] Specify copy mode: "update" copies only newer files, "merge"
                                         copies all files, "mirror" copies all files and removes any extranious files,
                                         "manual" opens an interactive sessions that allows a user to manually copy
                                         files.

  --no-autoload                          Prevents cli from automatically loading flags using project settings files.

  --resource=resource

  --stacks-dir=stacks-dir                Override default stack directory.

  --visible-stacks=visible-stacks        If specified only these stacks will be affected by this command.

See code: src/commands/job/cp.ts

cjr job:exec ID COMMAND

Start a new job using files from a completed or currently running job.

USAGE
  $ cjr job:exec ID COMMAND

OPTIONS
  -q, --quiet
  -v, --verbose                          shows output for each stage of the job.
  --async

  --build-mode=build-mode                [default: cached] specify how to build stack. Options include "reuse-image",
                                         "cached", "no-cache", "cached,pull", and "no-cache,pull"

  --config-files=config-files            [default: ] additional configuration file to override stack configuration

  --explicit

  --label=label                          [default: ] additional labels to append to job

  --message=message                      use this flag to tag a job with a user-supplied message

  --no-autoload                          prevents cli from automatically loading flags using project settings files

  --port=port                            [default: ]

  --profile=profile                      set stack profile

  --resource=resource

  --stack=stack

  --stacks-dir=stacks-dir                override default stack directory

  --sync

  --visible-stacks=visible-stacks        if specified only these stacks will be affected by this command

  --working-directory=working-directory  [default: /home/vagrant/cjr] cli will behave as if it was called from the
                                         specified directory

  --x11

See code: src/commands/job/exec.ts

cjr job:info [ID]

Get detailed information on the hidden properties of a job.

USAGE
  $ cjr job:info [ID]

OPTIONS
  --explicit
  --json
  --no-autoload                    prevents cli from automatically loading flags using project settings files
  --resource=resource
  --stacks-dir=stacks-dir          override default stack directory
  --visible-stacks=visible-stacks  if specified only these stacks will be affected by this command

See code: src/commands/job/info.ts

cjr job:log [ID]

Print console output generated by a job.

USAGE
  $ cjr job:log [ID]

OPTIONS
  --all                            show all output
  --explicit
  --lines=lines                    [default: 100]
  --no-autoload                    prevents cli from automatically loading flags using project settings files
  --resource=resource
  --stacks-dir=stacks-dir          override default stack directory
  --visible-stacks=visible-stacks  if specified only these stacks will be affected by this command

See code: src/commands/job/log.ts

cjr job:ls

List all running and completed jobs.

USAGE
  $ cjr job:ls

OPTIONS
  -v, --verbose                    shows all job properties.

  --all                            if this flag is added then list shows jobs from all stacks, regardless of whether
                                   stack flag is set

  --exited

  --explicit

  --json

  --no-autoload                    prevents cli from automatically loading flags using project settings files

  --resource=resource

  --running

  --stacks-dir=stacks-dir          override default stack directory

  --visible-stacks=visible-stacks  if specified only these stacks will be affected by this command

See code: src/commands/job/ls.ts

cjr job:rm [ID]

Delete a job and its associated data; works on both running and completed jobs.

USAGE
  $ cjr job:rm [ID]

OPTIONS
  -q, --quiet
  -v, --verbose
  --all
  --all-exited
  --all-running
  --explicit
  --no-autoload                    prevents cli from automatically loading flags using project settings files
  --resource=resource
  --stacks-dir=stacks-dir          override default stack directory
  --visible-stacks=visible-stacks  if specified only these stacks will be affected by this command

See code: src/commands/job/rm.ts

cjr job:shell [ID]

Start an interactive shell to view or modify a job's files or outputs.

USAGE
  $ cjr job:shell [ID]

OPTIONS
  -v, --verbose                          shows output for each stage of the job.

  --build-mode=build-mode                [default: reuse-image] specify how to build stack. Options include
                                         "reuse-image", "cached", "no-cache", "cached,pull", and "no-cache,pull"

  --config-files=config-files            [default: ] additional configuration file to override stack configuration

  --explicit

  --label=label                          [default: ] additional labels to append to job

  --no-autoload                          prevents cli from automatically loading flags using project settings files

  --port=port                            [default: ]

  --profile=profile                      set stack profile

  --resource=resource

  --stack=stack

  --stacks-dir=stacks-dir                override default stack directory

  --visible-stacks=visible-stacks        if specified only these stacks will be affected by this command

  --working-directory=working-directory  [default: /home/vagrant/cjr] cli will behave as if it was called from the
                                         specified directory

  --x11

See code: src/commands/job/shell.ts

cjr job:start COMMAND

Start a job that runs a shell command.

USAGE
  $ cjr job:start COMMAND

OPTIONS
  -q, --quiet
  -v, --verbose                          shows output for each stage of the job.
  --async

  --build-mode=build-mode                [default: cached] specify how to build stack. Options include "reuse-image",
                                         "cached", "no-cache", "cached,pull", and "no-cache,pull"

  --config-files=config-files            [default: ] additional configuration file to override stack configuration

  --copy                                 automatically copy files back to the project root on exit

  --explicit

  --file-access=volume|shared            [default: volume] how files are accessed from the container.

  --here                                 sets project-root to current working directory

  --label=label                          [default: ] additional labels to append to job

  --message=message                      use this flag to tag a job with a user-supplied message

  --no-autoload                          prevents cli from automatically loading flags using project settings files

  --no-copy                              do not copy files back to the project root on exit

  --port=port                            [default: ]

  --profile=profile                      set stack profile

  --project-root=project-root

  --resource=resource

  --stack=stack

  --stacks-dir=stacks-dir                override default stack directory

  --sync

  --working-directory=working-directory  [default: /home/vagrant/cjr] cli will behave as if it was called from the
                                         specified directory

  --x11

See code: src/commands/job/start.ts

cjr job:state ID

Get the current state of a job.

USAGE
  $ cjr job:state ID

OPTIONS
  --explicit
  --no-autoload                    prevents cli from automatically loading flags using project settings files
  --resource=resource
  --stacks-dir=stacks-dir          override default stack directory
  --visible-stacks=visible-stacks  if specified only these stacks will be affected by this command

See code: src/commands/job/state.ts

cjr job:stop [ID]

Stop a running job. This command has no effect on completed jobs.

USAGE
  $ cjr job:stop [ID]

OPTIONS
  -q, --quiet
  -v, --verbose
  --all                            stop all running jobs
  --explicit
  --no-autoload                    prevents cli from automatically loading flags using project settings files
  --resource=resource
  --stacks-dir=stacks-dir          override default stack directory
  --visible-stacks=visible-stacks  if specified only these stacks will be affected by this command

See code: src/commands/job/stop.ts

cjr jupyter:ls

List running Jupyter servers.

USAGE
  $ cjr jupyter:ls

OPTIONS
  --explicit
  --json
  --resource=resource

See code: src/commands/jupyter/ls.ts

cjr jupyter:start [PROJECT-ROOT]

Start a Jupyter server.

USAGE
  $ cjr jupyter:start [PROJECT-ROOT]

OPTIONS
  -h, --here                             sets project-root to current working directory
  -q, --quiet
  -v, --verbose                          shows output for each stage of the job.

  --build-mode=build-mode                [default: reuse-image] specify how to build stack. Options include
                                         "reuse-image", "cached", "no-cache", "cached,pull", and "no-cache,pull"

  --config-files=config-files            [default: ] additional configuration file to override stack configuration

  --explicit

  --expose

  --label=label                          [default: ] additional labels to append to job

  --no-autoload                          prevents cli from automatically loading flags using project settings files

  --override-entrypoint                  forces container entrypoint to be sh shell. This may be useful for images that
                                         where not designed for cjr.

  --port=port                            [default: ]

  --profile=profile                      set stack profile

  --project-root=project-root

  --resource=resource

  --server-port=server-port              [default: auto] default port for the jupyter server

  --stack=stack

  --stacks-dir=stacks-dir                override default stack directory

  --working-directory=working-directory  [default: /home/vagrant/cjr] cli will behave as if it was called from the
                                         specified directory

  --x11

See code: src/commands/jupyter/start.ts

cjr jupyter:stop [PROJECT-ROOT]

Stop a running Jupyter server.

USAGE
  $ cjr jupyter:stop [PROJECT-ROOT]

OPTIONS
  -h, --here                   sets project-root to current working directory
  -q, --quiet
  -v, --verbose                shows output for each stage of the job.
  --all                        stop all jupyter servers running in host directories
  --explicit
  --project-root=project-root
  --resource=resource

See code: src/commands/jupyter/stop.ts

cjr pconfig:item-append

Adds one element to an array configuration property

USAGE
  $ cjr pconfig:item-append

OPTIONS
  -q, --quiet
  --default-profile=default-profile
  --project-root=project-root        location where settings should be written

  --stack=stack                      profile will only activate for stacks matching this name. If this flag is not
                                     supplied, profile will apply to all stacks

  --visible-stack=visible-stack

See code: src/commands/pconfig/item-append.ts

cjr pconfig:item-remove

Removes one element of an array configuration property.

USAGE
  $ cjr pconfig:item-remove

OPTIONS
  -q, --quiet
  --default-profile=default-profile
  --project-root=project-root        location where settings should be written

  --stack=stack                      profile will only activate for stacks matching this name. If this flag is not
                                     supplied, profile will apply to all stacks

  --visible-stack=visible-stack

See code: src/commands/pconfig/item-remove.ts

cjr pconfig:ls

List all project settings.

USAGE
  $ cjr pconfig:ls

OPTIONS
  --no-autoload                prevents cli from automatically loading flags using project settings files
  --project-root=project-root  location where settings should be written

See code: src/commands/pconfig/ls.ts

cjr pconfig:profile:add [PATH]

Copies a configuration file into the current project profile directory.

USAGE
  $ cjr pconfig:profile:add [PATH]

OPTIONS
  --project-root=project-root

See code: src/commands/pconfig/profile/add.ts

cjr pconfig:rm

Remove one or more project settings.

USAGE
  $ cjr pconfig:rm

OPTIONS
  -q, --quiet
  --default-profiles           remove all additional overriding configuration files for project stack
  --project-root=project-root  location where settings should be written
  --project-root-auto          remove auto load for project
  --resource                   remove default resource for project
  --stack                      remove default stack for project
  --stacks-dir                 remove any overriding default stack directory for project
  --visible-stacks             if specified only these stacks will be affected by this command

See code: src/commands/pconfig/rm.ts

cjr pconfig:set

Overwrite one or more project settings.

USAGE
  $ cjr pconfig:set

OPTIONS
  -q, --quiet
  --project-root=project-root      location where settings should be written
  --project-root-auto
  --resource=resource              default resource for project
  --stack=stack                    default stack for project
  --stacks-dir=stacks-dir          override default stack directory for project
  --visible-stacks=visible-stacks  if specified only these stacks will be affected by this command

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

cjr resource:add RESOURCE

Add a remote resource.

USAGE
  $ cjr resource:add RESOURCE

OPTIONS
  --address=address          (required)
  --copy-key
  --key=key
  --storage-dir=storage-dir  location where job data is stored on remote host.
  --type=ssh                 (required)
  --username=username        (required)

See code: src/commands/resource/add.ts

cjr resource:ls

List all remote resources.

USAGE
  $ cjr resource:ls

OPTIONS
  -v, --verbose  show all properties for each remote resource.

See code: src/commands/resource/ls.ts

cjr resource:rm RESOURCE

Remove a remote resource.

USAGE
  $ cjr resource:rm RESOURCE

See code: src/commands/resource/rm.ts

cjr resource:set RESOURCE

Set a remote resource parameter.

USAGE
  $ cjr resource:set RESOURCE

OPTIONS
  --address=address
  --option-key=option-key      [default: ]
  --option-value=option-value  [default: ]
  --type=ssh
  --username=username

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

cjr resource:ssh [RESOURCE]

ssh into a remote resource.

USAGE
  $ cjr resource:ssh [RESOURCE]

OPTIONS
  -X, --x11
  --explicit
  --resource=resource

See code: src/commands/resource/ssh.ts

cjr resource:sync:ls [RESOURCE]

List running Syncthing servers.

USAGE
  $ cjr resource:sync:ls [RESOURCE]

OPTIONS
  --explicit
  --json
  --resource=resource

See code: src/commands/resource/sync/ls.ts

cjr resource:sync:reset [RESOURCE]

Reset Syncthing persistant storage directories.

USAGE
  $ cjr resource:sync:reset [RESOURCE]

OPTIONS
  -h, --here                   sets project-root to current working directory
  -q, --quiet
  -v, --verbose                shows output for each stage of the job.
  --explicit
  --project-root=project-root
  --resource=resource

See code: src/commands/resource/sync/reset.ts

cjr resource:sync:start [RESOURCE]

Start a Syncthing server.

USAGE
  $ cjr resource:sync:start [RESOURCE]

OPTIONS
  -h, --here                   sets project-root to current working directory
  -q, --quiet
  -v, --verbose                shows output for each stage of the job.
  --explicit
  --no-autoload                prevents cli from automatically loading flags using project settings files
  --project-root=project-root
  --resource=resource

See code: src/commands/resource/sync/start.ts

cjr resource:sync:stop [RESOURCE]

Stop a running Syncthing server.

USAGE
  $ cjr resource:sync:stop [RESOURCE]

OPTIONS
  -h, --here                   sets project-root to current working directory
  -q, --quiet
  -v, --verbose                shows output for each stage of the job.
  --all                        stop all jupyter servers running in host directories
  --explicit
  --project-root=project-root
  --resource=resource

See code: src/commands/resource/sync/stop.ts

cjr resource:tunnel:stop [RESOURCE]

Manually stop any running ssh multiplexor used to tunnel service ports.

USAGE
  $ cjr resource:tunnel:stop [RESOURCE]

OPTIONS
  --explicit
  --resource=resource

See code: src/commands/resource/tunnel/stop.ts

cjr shell

Start an interactive shell for development on localhost.

USAGE
  $ cjr shell

OPTIONS
  -h, --here                             sets project-root to current working directory
  -v, --verbose                          shows output for each stage of the job.

  --build-mode=build-mode                [default: reuse-image] specify how to build stack. Options include
                                         "reuse-image", "cached", "no-cache", "cached,pull", and "no-cache,pull"

  --config-files=config-files            [default: ] additional configuration file to override stack configuration

  --explicit

  --no-autoload                          prevents cli from automatically loading flags using project settings files

  --port=port                            [default: ]

  --profile=profile                      set stack profile

  --project-root=project-root

  --resource=resource

  --stack=stack

  --stacks-dir=stacks-dir                override default stack directory

  --working-directory=working-directory  [default: /home/vagrant/cjr] cli will behave as if it was called from the
                                         specified directory

  --x11

See code: src/commands/shell.ts

cjr stack:build [STACK]

Manually build an image for a stack.

USAGE
  $ cjr stack:build [STACK]

OPTIONS
  -q, --quiet
  --config-files=config-files  [default: ] additional configuration file to override stack configuration
  --explicit
  --no-cache
  --profile=profile            set stack profile
  --project-root=project-root
  --pull
  --resource=resource
  --stack=stack
  --stacks-dir=stacks-dir      override default stack directory

See code: src/commands/stack/build.ts

cjr stack:create NAME

Create a new cjr stack.

USAGE
  $ cjr stack:create NAME

OPTIONS
  --dockerfile=dockerfile  Create a new stack with using this Dockerfile.
  --explicit
  --image=image            Create a new stack based on an existing docker Image.
  --snapshottable          Create a new stack that supports snapshots.
  --stacks-dir=stacks-dir  override default stack directory

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

cjr stack:ls

List all the stacks in the stacks directory.

USAGE
  $ cjr stack:ls

OPTIONS
  --stacks-dir=stacks-dir  override default stack directory

See code: src/commands/stack/ls.ts

cjr stack:pull URL

Clones or pulls a stack using git directly into the stack folder.

USAGE
  $ cjr stack:pull URL

OPTIONS
  --explicit
  --stacks-dir=stacks-dir  override default stack directory

See code: src/commands/stack/pull.ts

cjr stack:rmi [STACK]

Delete an image one or more stacks.

USAGE
  $ cjr stack:rmi [STACK]

OPTIONS
  -q, --quiet
  --all-configurations
  --config-files=config-files  [default: ] additional configuration file to override stack configuration
  --explicit
  --stack=stack
  --stacks-dir=stacks-dir      override default stack directory

See code: src/commands/stack/rmi.ts

cjr stack:snapshot [STACK]

Start an interactive shell for development on localhost.

USAGE
  $ cjr stack:snapshot [STACK]

OPTIONS
  -h, --here                             sets project-root to current working directory
  -v, --verbose                          shows output for each stage of the job.

  --build-mode=build-mode                [default: reuse-image] specify how to build stack. Options include
                                         "reuse-image", "cached", "no-cache", "cached,pull", and "no-cache,pull"

  --config-files=config-files            [default: ] additional configuration file to override stack configuration

  --explicit

  --no-autoload                          prevents cli from automatically loading flags using project settings files

  --port=port                            [default: ]

  --profile=profile                      set stack profile

  --project-root=project-root

  --stack=stack

  --stacks-dir=stacks-dir                override default stack directory

  --working-directory=working-directory  [default: /home/vagrant/cjr] cli will behave as if it was called from the
                                         specified directory

  --x11

See code: src/commands/stack/snapshot.ts

cjr theia:ls

List running Theia servers.

USAGE
  $ cjr theia:ls

OPTIONS
  --explicit
  --json
  --resource=resource

See code: src/commands/theia/ls.ts

cjr theia:start [PROJECT-ROOT]

Start a Theia server.

USAGE
  $ cjr theia:start [PROJECT-ROOT]

OPTIONS
  -h, --here                             sets project-root to current working directory
  -q, --quiet
  -v, --verbose                          shows output for each stage of the job.

  --build-mode=build-mode                [default: reuse-image] specify how to build stack. Options include
                                         "reuse-image", "cached", "no-cache", "cached,pull", and "no-cache,pull"

  --config-files=config-files            [default: ] additional configuration file to override stack configuration

  --explicit

  --expose

  --label=label                          [default: ] additional labels to append to job

  --no-autoload                          prevents cli from automatically loading flags using project settings files

  --override-entrypoint                  forces container entrypoint to be sh shell. This may be useful for images that
                                         where not designed for cjr.

  --port=port                            [default: ]

  --profile=profile                      set stack profile

  --project-root=project-root

  --resource=resource

  --server-port=server-port              [default: auto] default port for the jupyter server

  --stack=stack

  --stacks-dir=stacks-dir                override default stack directory

  --working-directory=working-directory  [default: /home/vagrant/cjr] cli will behave as if it was called from the
                                         specified directory

  --x11

See code: src/commands/theia/start.ts

cjr theia:stop [PROJECT-ROOT]

Stop a running Theia server.

USAGE
  $ cjr theia:stop [PROJECT-ROOT]

OPTIONS
  -h, --here                   sets project-root to current working directory
  -q, --quiet
  -v, --verbose                shows output for each stage of the job.
  --all                        stop all jupyter servers running in host directories
  --explicit
  --project-root=project-root
  --resource=resource

See code: src/commands/theia/stop.ts

cjr vnc:ls

List running VNC servers.

USAGE
  $ cjr vnc:ls

OPTIONS
  --explicit
  --json
  --resource=resource

See code: src/commands/vnc/ls.ts

cjr vnc:start [PROJECT-ROOT]

Start a VNC server.

USAGE
  $ cjr vnc:start [PROJECT-ROOT]

OPTIONS
  -h, --here                             sets project-root to current working directory
  -q, --quiet
  -v, --verbose                          shows output for each stage of the job.

  --build-mode=build-mode                [default: reuse-image] specify how to build stack. Options include
                                         "reuse-image", "cached", "no-cache", "cached,pull", and "no-cache,pull"

  --config-files=config-files            [default: ] additional configuration file to override stack configuration

  --explicit

  --expose

  --label=label                          [default: ] additional labels to append to job

  --no-autoload                          prevents cli from automatically loading flags using project settings files

  --override-entrypoint                  forces container entrypoint to be sh shell. This may be useful for images that
                                         where not designed for cjr.

  --port=port                            [default: ]

  --profile=profile                      set stack profile

  --project-root=project-root

  --resource=resource

  --server-port=server-port              [default: auto] default port for the jupyter server

  --stack=stack

  --stacks-dir=stacks-dir                override default stack directory

  --working-directory=working-directory  [default: /home/vagrant/cjr] cli will behave as if it was called from the
                                         specified directory

  --x11

See code: src/commands/vnc/start.ts

cjr vnc:stop [PROJECT-ROOT]

Stop a running VNC server.

USAGE
  $ cjr vnc:stop [PROJECT-ROOT]

OPTIONS
  -h, --here                   sets project-root to current working directory
  -q, --quiet
  -v, --verbose                shows output for each stage of the job.
  --all                        stop all jupyter servers running in host directories
  --explicit
  --project-root=project-root
  --resource=resource

See code: src/commands/vnc/stop.ts