Skip to main content
Version: v2.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
CommandUsageDescription
getlit init | heregetlit init๐Ÿ Initialise a new Lit project
getlit buildgetlit build๐Ÿ— Build your Lit Actions
getlit new | actiongetlit new [<lit-action-name>]๐Ÿ“ Create a new Lit Action
getlit testgetlit test [<lit-action-name>]๐Ÿงช Test a Lit Action
getlit watchgetlit watch [<lit-action-name>]๐Ÿ”ง Simultaneously build and test a Lit Action
getlit setupgetlit setup๐Ÿ”‘ Setup config for authSig and PKP
getlit docs | docgetlit docs๐Ÿ“– Open the Lit Protocol documentation
getlit help | showhelp๐Ÿ†˜ Show the help menu

Usageโ€‹

To use the GetLit CLI, simply run the desired command followed by any required or optional arguments. The CLI will execute the associated function and display the output accordingly.