https://github.com/lennetech/cli
A CLI for lenne.Tech libraries and frameworks.
https://github.com/lennetech/cli
cli git git-tools gluegun helper lenne lennetech nest-server tech
Last synced: 14 days ago
JSON representation
A CLI for lenne.Tech libraries and frameworks.
- Host: GitHub
- URL: https://github.com/lennetech/cli
- Owner: lenneTech
- License: mit
- Created: 2019-08-13T12:00:03.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-15T13:11:38.000Z (over 1 year ago)
- Last Synced: 2024-12-19T08:22:29.219Z (over 1 year ago)
- Topics: cli, git, git-tools, gluegun, helper, lenne, lennetech, nest-server, tech
- Language: TypeScript
- Homepage:
- Size: 2.14 MB
- Stars: 10
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# lt CLI
A CLI for [lenne.Tech](https://github.com/lenneTech) libraries and frameworks.
CLI in action:
[](/LICENSE) [](https://circleci.com/gh/lenneTech/cli/tree/master)
[](https://david-dm.org/lenneTech/cli) [](https://david-dm.org/lenneTech/cli?type=dev)
## Installation
```
$ npm install -g @lenne.tech/cli
```
## Usage
```
Menu mode
$ lt
or command line mode
$ lt () ()
```
## Help / List of commands
```
$ lt help
or
$ lt
```
## Documentation
- **[LT-ECOSYSTEM-GUIDE](docs/LT-ECOSYSTEM-GUIDE.md)** — Complete reference for `lt` CLI **and** the `lt-dev` Claude-Code Plugin (architecture, functions, vendor-mode workflows, agents, skills)
- **[VENDOR-MODE-WORKFLOW](docs/VENDOR-MODE-WORKFLOW.md)** — Step-by-step guide for npm → vendor conversion, updates, and rollback
- [Command Reference](docs/commands.md) — Complete list of all commands with options
- [Configuration Guide](docs/lt.config.md) — Configuration file documentation
- [Plugin Guide](docs/plugins.md) — How to create plugins
## Quick Start
```bash
# Check your environment
$ lt doctor
# Show project status
$ lt status
# Enable shell completions
$ lt completion install
```
## Framework consumption modes (nest-server)
When you create a new api project (`lt fullstack init` or `lt server create`),
the CLI supports two framework consumption modes:
**`npm` mode (default)** — `@lenne.tech/nest-server` is installed as an npm
dependency. Framework source lives in `node_modules/@lenne.tech/nest-server/`.
Imports use the bare specifier `from '@lenne.tech/nest-server'`. Update path:
`/lt-dev:backend:update-nest-server` (Claude Code agent).
**`vendor` mode** — The framework's `core/` directory is copied directly into
`/src/core/` as first-class project code. No `@lenne.tech/nest-server`
npm dependency. Generated imports use relative paths (`from '../../../core'`).
Local patches are allowed and tracked in `src/core/VENDOR.md`. Update path:
`/lt-dev:backend:update-nest-server-core` (Claude Code agent).
### Creating projects
```bash
# npm mode (classic, default)
$ lt fullstack init --name myapp --frontend nuxt --api-mode Rest
# vendor mode, HEAD of upstream
$ lt fullstack init --name myapp --frontend nuxt --api-mode Rest \
--framework-mode vendor
# vendor mode, pinned to a specific upstream branch or tag
$ lt fullstack init --name myapp --framework-mode vendor \
--framework-upstream-branch 11.24.1
# dry-run: print the plan without touching the filesystem
$ lt fullstack init --name myapp --framework-mode vendor --dry-run --noConfirm
# standalone api project (vendor mode works here too)
$ lt server create --name myapp --framework-mode vendor
```
### Working on an existing project
All `lt server …` commands (module, object, addProp, test, permissions)
**auto-detect** the framework mode via `src/core/VENDOR.md` and generate
the correct import syntax automatically. You never pass `--framework-mode`
after `init`; it is persisted in the project's `lt.config.json`.
```bash
# inside projects/api — generates relative or bare imports automatically
$ lt server module --name Product --controller Rest
# shows the mode + project type
$ lt status
# prints the mode-specific update instructions
$ lt fullstack update
```
### Vendor-mode housekeeping
Vendor-mode projects ship three maintenance scripts under `scripts/vendor/`:
| Script | Purpose | Invocation |
|---|---|---|
| `check-vendor-freshness.mjs` | Non-blocking warning when upstream has a newer release than the current baseline | `pnpm run check:vendor-freshness` (auto-invoked by `pnpm run check` / `check:fix` / `check:naf`) |
| `sync-from-upstream.ts` | Diff generator consumed by the `nest-server-core-updater` Claude Code agent | `pnpm run vendor:sync` |
| `propose-upstream-pr.ts` | Patch-list generator consumed by the `nest-server-core-contributor` agent | `pnpm run vendor:propose-upstream` |
The vendor-mode baseline (upstream version + commit SHA) is recorded in
`src/core/VENDOR.md`. Log any substantial local patch there so the updater
agent can classify it at sync time.
### Integration test
A full end-to-end smoke test for all four supported init combinations
(`npm/Rest`, `vendor/Rest`, `vendor/GraphQL`, `vendor/Both`) ships with the
CLI:
```bash
$ pnpm run test:vendor-init
```
Each scenario runs init → module → object → addProp → test → tsc → build →
migrate:list and asserts ~30 structural + functional invariants per scenario.
Run this before releasing a new CLI version to catch upstream drift early.
## Configuration
The CLI supports project-specific configuration via `lt.config` files. This allows you to set default values for commands, reducing repetitive input.
```bash
# 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](docs/lt.config.md).
## Examples
```
// Start
$ lt
// Create new server
$ lt server create
or
$ lt server c
// Create new module for server (in server project root dir)
$ lt server module
or
$ lt server m
// 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
or
$ lt git g
// 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](https://infinitered.github.io/gluegun)
and all the developers whose packages are used here.
## License
MIT - see LICENSE