npm.io
1.0.4 • Published 6 months agoCLI

@10up/ignite-cli

Licence
MIT
Version
1.0.4
Deps
6
Size
68 kB
Vulns
1
Weekly
0
SummaryDependencyVersions

Ignite CLI

A command-line tool for managing Ignite WP plugins in your WordPress projects.

Installation

Run directly with npx:

npx @10up/ignite-cli

Commands

Install (Composer)

Add Ignite plugins to your project via Composer with GitHub VCS repositories.

# Interactive mode - select plugins from a list
npx @10up/ignite-cli install

# Direct mode - specify plugins by slug
npx @10up/ignite-cli install accordion carousel icons

This command will:

  • Add GitHub VCS repositories to your composer.json
  • Add the selected plugins to the require section
  • Automatically include dependencies
  • Run composer update for the selected packages
Download (Non-Composer)

Download Ignite plugins directly from GitHub releases without using Composer.

# Interactive mode - select plugins from a list
npx @10up/ignite-cli download

# Direct mode - specify plugin and optional tag
npx @10up/ignite-cli download accordion --tag v1.2.0

This command will:

  • Fetch the latest release from GitHub
  • Download and extract to your plugins directory
  • Skip composer.json modifications

Note: Plugins installed this way will not receive automatic updates via Composer.

Eject (Fork)

Remove a plugin from Composer management and track it in version control.

# Interactive mode - select from installed plugins
npx @10up/ignite-cli eject

# Direct mode - specify plugin by slug
npx @10up/ignite-cli eject accordion

This command will:

  • Remove the plugin from composer.json
  • Update .gitignore to track the plugin
  • Preserve the plugin files in your plugins directory

Use this when you need to customize a plugin for your specific project.

Requirements

  • Node.js 18 or higher
  • Composer installed and available in PATH
  • Git repository with .gitignore file

How It Works

The CLI tool manages Ignite plugins through three different workflows:

  1. Composer Install: Uses GitHub VCS repositories to install plugins via Composer, allowing for version management and easy updates.

  2. Direct Download: Fetches release archives from GitHub and extracts them to your plugins directory, useful for quick testing or when Composer is not desired.

  3. Ejection: Converts a Composer-managed plugin into a tracked, customizable plugin in your repository.

Plugin Registry

The CLI includes metadata for all available Ignite plugins, including:

  • Plugin names and descriptions
  • Composer package names
  • GitHub repository URLs
  • Dependencies between plugins
  • Version requirements

License

MIT

Keywords

wordpressignitecliplugins