Skip to main content
Version: v3.x.x

GetLit CLI

The GetLit CLI is a command-line tool designed to help developers manage their Lit Actions projects. The CLI provides a set of commands to create, build, test, and configure Lit Actions.

Getting Startedโ€‹

npm install -g getlit

// or
yarn add global getlit

Usageโ€‹

To use the GetLit CLI, navigate to a directory or your existing project, and then simply run the desired command followed by any required or optional arguments. The CLI will execute the associated function and display the output accordingly.

CommandUsageDescription
action | initgetlit action๐Ÿ Initialise a new Lit project
buildgetlit build๐Ÿ— Build your Lit Actions
newgetlit new [<lit-action-name>]๐Ÿ“ Create a new Lit Action
testgetlit test [<lit-action-name>]๐Ÿงช Test a Lit Action
watchgetlit watch [<lit-action-name>]๐Ÿ”ง Simultaneously build and test a Lit Action
setupgetlit setup๐Ÿ”‘ Setup config for authSig and PKP
docs | docgetlit docs๐Ÿ“– Open the Lit Protocol documentation
help | showgetlit help๐Ÿ†˜ Show the help menu