_____ _ _____ _ _____
|_ _| | | / ____| | |_ _|
| | _ __ ___ __ _ __ _ ___| | __ _ _ __ ___ ___ ______ | | | | | |
| | | '_ ` _ \ / _` |/ _` |/ _ \ |/ _` | '_ \ / __/ _ \ |______| | | | | | |
_| |_| | | | | | (_| | (_| | __/ | (_| | | | | (_| __/ | |____| |____ _| |_
|_____|_| |_| |_|\__,_|\__, |\___|_|\__,_|_| |_|\___\___| \_____|______|_____|
__/ |
|___/
We have 3 separate ways of installing the Imagelance CLI tool. Please select whichever you like.
1. Install with an Installer
2. Standalone installation with a Tarball
The standalone installation is a simple tarball with a binary. It contains its own node.js binary and autoupdates.
3. Install with npm/yarn
npm install -g imagelance-cli
or
yarn global add imagelance-cli
- Log in to your account
$ lance login
- Create directory structure
$ lance install
- Sync templates
$ lance sync
$ lance help
$ npm install -g imagelance-cli
$ lance COMMAND
running command...
$ lance (--version)
imagelance-cli/3.0.17 darwin-arm64 node-v18.18.2
$ lance --help [COMMAND]
USAGE
$ lance COMMAND
...
lance autocomplete [SHELL]
lance clone REPONAME
lance convert-pdf
lance create
lance dev
lance fetch
lance help [COMMAND]
lance install
lance login
lance pull
lance push
lance status
lance sync
lance update [CHANNEL]
lance validate
Display autocomplete installation instructions.
USAGE
$ lance autocomplete [SHELL] [-r]
ARGUMENTS
SHELL (zsh|bash|powershell) Shell type
FLAGS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
DESCRIPTION
Display autocomplete installation instructions.
EXAMPLES
$ lance autocomplete
$ lance autocomplete bash
$ lance autocomplete zsh
$ lance autocomplete powershell
$ lance autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
Clone existing template
USAGE
$ lance clone REPONAME [-d]
FLAGS
-d, --debug Debug mode
DESCRIPTION
Clone existing template
See code: src/commands/clone.ts
Convert pdf to jpg
USAGE
$ lance convert-pdf [-d]
FLAGS
-d, --debug Debug mode
DESCRIPTION
Convert pdf to jpg
See code: src/commands/convert-pdf.ts
Creates new template
USAGE
$ lance create [-d]
FLAGS
-d, --debug Debug mode
DESCRIPTION
Creates new template
See code: src/commands/create.ts
Run development server to create templates
USAGE
$ lance dev [-d] [-l] [-n]
FLAGS
-d, --debug Debug mode
-l, --latest Start dev with latest edited template
-n, --newest Start dev with newly created template
DESCRIPTION
Run development server to create templates
See code: src/commands/dev.ts
Fetch all local templates
USAGE
$ lance fetch [-d]
FLAGS
-d, --debug Debug mode
DESCRIPTION
Fetch all local templates
See code: src/commands/fetch.ts
Display help for lance.
USAGE
$ lance 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 lance.
See code: @oclif/plugin-help
Set home directory for templates and prepare dev environment
USAGE
$ lance install [-d]
FLAGS
-d, --debug Debug mode
DESCRIPTION
Set home directory for templates and prepare dev environment
See code: src/commands/install.ts
Authorize CLI against web application
USAGE
$ lance login [-d]
FLAGS
-d, --debug Debug mode
DESCRIPTION
Authorize CLI against web application
See code: src/commands/login.ts
Pull all local templates
USAGE
$ lance pull [-d]
FLAGS
-d, --debug Debug mode
DESCRIPTION
Pull all local templates
See code: src/commands/pull.ts
Push all local templates
USAGE
$ lance push [-d]
FLAGS
-d, --debug Debug mode
DESCRIPTION
Push all local templates
See code: src/commands/push.ts
Git status of all local templates
USAGE
$ lance status [-d]
FLAGS
-d, --debug Debug mode
DESCRIPTION
Git status of all local templates
See code: src/commands/status.ts
Download all synced templates
USAGE
$ lance sync [-d] [-s]
FLAGS
-d, --debug Debug mode
-s, --shallow Perform shallow fetch
DESCRIPTION
Download all synced templates
See code: src/commands/sync.ts
update the lance CLI
USAGE
$ lance update [CHANNEL] [-a] [--force] [-i | -v <value>]
FLAGS
-a, --available See available versions.
-i, --interactive Interactively select version to install. This is ignored if a channel is provided.
-v, --version=<value> Install a specific version.
--force Force a re-download of the requested version.
DESCRIPTION
update the lance CLI
EXAMPLES
Update to the stable channel:
$ lance update stable
Update to a specific version:
$ lance update --version 1.0.0
Interactively select version:
$ lance update --interactive
See available versions:
$ lance update --available
See code: @oclif/plugin-update
Validate the config and schema of all local templates
USAGE
$ lance validate [-d]
FLAGS
-d, --debug Debug mode
DESCRIPTION
Validate the config and schema of all local templates
See code: src/commands/validate.ts