Installation & Setup

Installation

Install Using @panda/command

If you just want to use Command, you can install it directly from @panda/command:

npm

npm install @panda/command

Yarn

yarn add @panda/command

pnpm

pnpm add @panda/command

Install Using panda

The panda library contains Command, along with a lot of other entities and functionality.

npm

npm install panda

Yarn

yarn add panda

pnpm

pnpm add panda

Setup

Include

// ESM
import { Command } from '@panda/command'
// CommonJS
const { Command } = require('@panda/command')

Create

Commands can be creating either by extending the Command class or creating a new instance of it.

Instantiate Command

import { Command } from '@panda/command'

const cmd = new Command({
  name: 'foo:create',
  action: async (data, details) => {}
})

Extend Command

import { Command } from '@panda/command'

export const FooCreateCommand extends Command {
  name = 'foo:create'

  async action (data, details) {}
}

Run

./my-script.js

1. Call the script directly (example: ./my-script.js)
2. Call the script via node (example: node my-script.js)
3. Add the script to your package.json into scripts and run npm run <script>
4. Add the script to your package.json into bin and run npm link (or install globally) to run as an independent command

When running a script directly (without using NPM or Node), be sure to include the following in your script:

#!/usr/bin/env node