@arthuravianna/lit-cli
v0.0.2
Published
A Lit CLI tool to create Vincent Abilities and Policies
Downloads
6
Readme
lit-cli
A command-line interface for building, deploying, and managing Lit Protocol projects. This CLI helps developers create Vincent Abilities and Vincent Policies, build them for deployment, and deploy them to IPFS.
Usage
$ npm install -g @arthuravianna/lit-cli
$ lit COMMAND
running command...
$ lit (--version)
@arthuravianna/lit-cli/0.0.2 linux-x64 node-v22.20.0
$ lit --help [COMMAND]
USAGE
$ lit COMMAND
...What is lit-cli?
The Lit CLI is a developer tool for building and deploying projects on the Lit Protocol network. It provides functionality to:
- Create Vincent Abilities: Initialize new Vincent Ability projects from templates
- Build Projects: Bundle and compile Lit Protocol projects for deployment
- Deploy to IPFS: Upload compiled Lit Actions to IPFS via Pinata with automatic CID generation and verification
Typical Workflow
Create a new project:
lit create vincent-ability my-awesome-abilityBuild your project:
cd my-awesome-ability lit buildDeploy to IPFS:
lit deploy --pinata-jwt your-jwt-token
The CLI handles template downloading, project scaffolding, esbuild compilation, IPFS CID generation, and deployment to Pinata automatically.
Commands
lit buildlit create vincent-ability PROJECTlit create vincent-policy [FILE]lit deploylit help [COMMAND]lit pluginslit plugins add PLUGINlit plugins:inspect PLUGIN...lit plugins install PLUGINlit plugins link PATHlit plugins remove [PLUGIN]lit plugins resetlit plugins uninstall [PLUGIN]lit plugins unlink [PLUGIN]lit plugins update
lit build
build and test the lit project
USAGE
$ lit build [--noTest]
FLAGS
--noTest skip e2e tests
DESCRIPTION
build and test the lit project
EXAMPLES
$ lit buildSee code: src/commands/build.ts
lit create vincent-ability PROJECT
Initialize a project template to create a Vincent ability
USAGE
$ lit create vincent-ability PROJECT [-n <value>] [-d <value>]
ARGUMENTS
PROJECT project name
FLAGS
-d, --description=<value> Vincent Ability Description
-n, --npm_package=<value> Vincent Ability npm package name
DESCRIPTION
Initialize a project template to create a Vincent ability
EXAMPLES
$ lit create vincent-abilitySee code: src/commands/create/vincent-ability.ts
lit create vincent-policy [FILE]
Initialize a project template to create a Vincent policy
USAGE
$ lit create vincent-policy [FILE] [-f] [-n <value>]
ARGUMENTS
[FILE] project name
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
Initialize a project template to create a Vincent policy
EXAMPLES
$ lit create vincent-policySee code: src/commands/create/vincent-policy.ts
lit deploy
Deploy the bundled Lit Action to IPFS (via Pinata) and NPM
USAGE
$ lit deploy -f <value> [-j <value>]
FLAGS
-f, --envFile=<value> (required) [default: .env] use .env file
-j, --pinataJwt=<value> Pinata JWT token (overrides .env file)
DESCRIPTION
Deploy the bundled Lit Action to IPFS (via Pinata) and NPM
EXAMPLES
$ lit deploySee code: src/commands/deploy.ts
lit help [COMMAND]
Display help for lit.
USAGE
$ lit 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 lit.See code: @oclif/plugin-help
lit plugins
List installed plugins.
USAGE
$ lit plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ lit pluginsSee code: @oclif/plugin-plugins
lit plugins add PLUGIN
Installs a plugin into lit.
USAGE
$ lit plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into lit.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the LIT_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the LIT_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ lit plugins add
EXAMPLES
Install a plugin from npm registry.
$ lit plugins add myplugin
Install a plugin from a github url.
$ lit plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ lit plugins add someuser/somepluginlit plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ lit plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ lit plugins inspect mypluginSee code: @oclif/plugin-plugins
lit plugins install PLUGIN
Installs a plugin into lit.
USAGE
$ lit plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into lit.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the LIT_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the LIT_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ lit plugins add
EXAMPLES
Install a plugin from npm registry.
$ lit plugins install myplugin
Install a plugin from a github url.
$ lit plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ lit plugins install someuser/somepluginSee code: @oclif/plugin-plugins
lit plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ lit plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ lit plugins link mypluginSee code: @oclif/plugin-plugins
lit plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ lit plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ lit plugins unlink
$ lit plugins remove
EXAMPLES
$ lit plugins remove mypluginlit plugins reset
Remove all user-installed and linked plugins.
USAGE
$ lit plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.See code: @oclif/plugin-plugins
lit plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ lit plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ lit plugins unlink
$ lit plugins remove
EXAMPLES
$ lit plugins uninstall mypluginSee code: @oclif/plugin-plugins
lit plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ lit plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
[PLUGIN...] plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ lit plugins unlink
$ lit plugins remove
EXAMPLES
$ lit plugins unlink mypluginlit plugins update
Update installed plugins.
USAGE
$ lit plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.See code: @oclif/plugin-plugins
