Skip to content

lenneTech/cli

Repository files navigation

lt CLI

A CLI for lenne.Tech libraries and frameworks.

CLI in action:

Gluegun Menu Demo

License CircleCI Dependency Status devDependency Status

Installation

$ npm install -g @lenne.tech/cli

Usage

Menu mode
$ lt
or command line mode
$ lt <command> (<subcommand>) (<parameter>)

Help / List of commands

$ lt help
or
$ lt

Documentation

Quick Start

# Check your environment
$ lt doctor

# Show project status
$ lt status

# Enable shell completions
$ lt completion install

Configuration

The CLI supports project-specific configuration via lt.config files. This allows you to set default values for commands, reducing repetitive input.

# Create a configuration file interactively
$ lt config init

# Show current configuration (merged from hierarchy)
$ lt config show

Supported formats:

  • lt.config.json - JSON format (recommended)
  • lt.config.yaml - YAML format
  • lt.config - Auto-detected format

Configuration files are searched from the current directory up to root and merged hierarchically.

For detailed documentation, see docs/lt.config.md.

Examples

// Start
$ lt

// Create new server
$ lt server create <ServerName>
or
$ lt server c <ServerName>

// Create new module for server (in server project root dir)
$ lt server module <ModuleName>
or
$ lt server m <ModuleName>

// Update and install npm packages (in project dir)
$ lt npm update
or
$ lt npm up
or
$ lt npm u

// Checkout git branch and update packages (in project dir)
$ lt git get <branch-name or part-of-branch-name>
or
$ lt git g <branch-name or part-of-branch-name>

// Preview what a command would do (dry-run)
$ lt git clear --dry-run
$ lt git reset --dry-run
$ lt git squash --dry-run
$ lt git rebase --dry-run

// Skip confirmation prompts (noConfirm)
$ lt git get feature --noConfirm
$ lt git squash dev --noConfirm

// Combine flags for CI/CD pipelines
$ lt git clean --noConfirm
$ lt server module User --noConfirm

// View command history
$ lt history

...

Development

# Clone project
git clone git@github.com:lenneTech/cli.git
cd cli

# Link the project for global usage
npm link

# Make changes
...

# Test changes
lt ...

# Build new version
npm build

Thanks

Many thanks to the developers of Glugun and all the developers whose packages are used here.

License

MIT - see LICENSE

About

A CLI for lenne.Tech libraries and frameworks.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 7