Skip to Content
DocumentationπŸ”§ Loopstack CLI

πŸ”§ Loopstack CLI

The Loopstack CLI is a command-line tool that enables you to install packages from the Loopstack RegistryΒ  directly into your project, giving you full control and customization capabilities.

Installation

Install the Loopstack CLI globally:

npm install -g @loopstack/cli

Commands

add

Add a package from the Loopstack Registry to your project.

loopstack add <item>

Arguments:

  • <item>: (mandatory) The name of the package to install from the registry

Options:

OptionAliasDescription
--dir <directory>-dTarget directory for installation
--skip-depsSkip dependency installation
--package-manager <manager>-pmPackage manager to use (npm or pnpm)

Examples:

# Install a package with interactive prompts loopstack add my-workflow-template # Install to a specific directory loopstack add my-workflow-template --dir src/workflows/custom # Install without adding dependencies loopstack add my-workflow-template --skip-deps # Specify package manager explicitly loopstack add my-workflow-template --package-manager pnpm

How It Works

When you run loopstack add <item>, the CLI performs the following steps:

  1. Registry Lookup: Fetches the package from the Loopstack RegistryΒ 
  2. Directory Selection: Prompts for target directory (defaults to src/<package-name>)
  3. File Installation: Copies the src folder of the package to your target directory
  4. Dependency Handling: Detects and optionally installs package dependencies

Why Source Code Installation?

Copying dependency sources directly into your project has several benefits:

  • A starting point with pre defined and tested templates and tools
  • Enabling customization to achieve 100% accuracy for your specific needs
  • Maintaining full control and ownership of the code
  • Learn concepts and patterns efficiently

When not to choose Source Code Installation?

Do not use loopstack add (and use npm install instead) when:

  • No custom changes to the imported functionality is needed
  • You want to maintain simple updatability for future versions using npm update
  • You want to contribute back to the package - use git to fork the original repository instead

Getting Help

  • Check the registry for available packages: https://loopstack.ai/registryΒ 
  • Review package documentation in the repository
  • Join the Loopstack discord server for support
Last updated on