https://github.com/lit-protocol/getlit
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.
https://github.com/lit-protocol/getlit
cli decentralised ipfs litprotocol
Last synced: about 1 year ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/lit-protocol/getlit
- Owner: LIT-Protocol
- Created: 2023-03-14T16:41:11.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-25T19:03:43.000Z (almost 2 years ago)
- Last Synced: 2025-04-12T00:07:33.972Z (about 1 year ago)
- Topics: cli, decentralised, ipfs, litprotocol
- Language: TypeScript
- Homepage: https://getlit.dev/
- Size: 2.06 MB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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.
- GitHub repo: https://github.com/LIT-Protocol/getlit
- npm: https://www.npmjs.com/getlit
## 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.
| Command | Usage | Description |
| ------------------------ | ----------------------------------- | ----------------------------------------- |
| `action` \| `init` | `getlit action` | 🏁 Initialise a new Lit project |
| `build` | `getlit build` | 🏗 Build your Lit Actions |
| `new` | `getlit new []` | 📝 Create a new Lit Action |
| `test` | `getlit test []` | 🧪 Test a Lit Action |
| `watch` | `getlit watch []` | 🔧 Simultaneously build and test a Lit Action |
| `setup` | `getlit setup` | 🔑 Setup config for authSig and PKP |
| `deploy` | `getlit deploy` | Deploy your Lit Actions |
| `derive` | `getlit derive` | Derive a pkp pubkey with auth method data |
| `pkp-search` | `getlit pkp-search` | search for pkp information |
|`docs` \| `doc` | `getlit docs` | 📖 Open the Lit Protocol documentation |
| `help` \| `show` | `getlit help` | 🆘 Show the help menu |
| `create-next-app` | `getlit create-next-app` | 🏁 Initialise a new Lit next-app project |
| `create-react-app` | `getlit create-react-app` | 🏁 Initialise a new Lit react-app project |