Metadata-Version: 2.4
Name: kctl-n8n
Version: 0.6.0
Summary: Kodemeio n8n CLI — manage n8n workflow automation instances via the public REST API
Author-email: Kodemeio <dev@kodeme.io>
License-Expression: MIT
Keywords: automation,cli,kodemeio,n8n,workflow
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=3.12
Requires-Dist: httpx>=0.28.0
Requires-Dist: kctl-lib>=0.13.0
Requires-Dist: pydantic>=2.10.0
Requires-Dist: pyyaml>=6.0.2
Requires-Dist: rich>=13.9.0
Requires-Dist: typer>=0.15.0
Provides-Extra: dev
Requires-Dist: mypy>=1.14.0; extra == 'dev'
Requires-Dist: pytest-httpx>=0.35.0; extra == 'dev'
Requires-Dist: pytest>=8.3.0; extra == 'dev'
Requires-Dist: ruff>=0.9.0; extra == 'dev'
Requires-Dist: types-pyyaml>=6.0.0; extra == 'dev'
Description-Content-Type: text/markdown

# kctl-n8n

Kodemeio CLI for [n8n](https://n8n.io) workflow automation instances.

Wraps the n8n public REST API with the same UX patterns as the rest of the `kctl-*` suite (profiles, shared config at `~/.config/kodemeio/config.yaml`, `--json` output, rich tables).

## Install

```bash
uv tool install --reinstall --from packages/kctl-n8n kctl-n8n
```

## Quick start

```bash
# Configure a profile
kctl-n8n config init --name idtpp --url https://n8n.idtpp.com --api-key "$N8N_API_KEY"

# Use it
kctl-n8n -p idtpp health
kctl-n8n -p idtpp workflows list
kctl-n8n -p idtpp executions list --limit 10
```

## Command groups

| Group | Purpose |
|---|---|
| `workflows` | list / get / create / update / delete / activate / deactivate / transfer / tags |
| `executions` | list / get / delete past workflow runs |
| `credentials` | create / delete / schema / transfer credentials |
| `users` | list / get / create / delete / change-role |
| `variables` | list / create / update / delete environment variables |
| `tags` | list / get / create / update / delete tags |
| `projects` | list / create / update / delete projects (Enterprise) |
| `audit` | generate audit reports |
| `source-control` | pull / push for Git-based workflow management |
| `config` | manage profiles in `~/.config/kodemeio/config.yaml` |
| `health` | `/healthz` check |
| `dashboard` | high-level instance overview |
| `doctor` | diagnostic checks |
| `skill` | generate the `n8n-admin` Claude Code skill + install MCP skills |

## Profile config

Stored under `~/.config/kodemeio/config.yaml` with service key `n8n`:

```yaml
profiles:
  idtpp:
    n8n:
      url: https://n8n.idtpp.com
      api_key: ${N8N_IDTPP_API_KEY}     # env var expansion supported
      tenant: tpp                        # optional
```

## Skills

`kctl-n8n` bundles 8 Claude Code skills (one CLI-admin skill + 7 n8n-mcp workflow skills from [czlonkowski/n8n-skills](https://github.com/czlonkowski/n8n-skills)):

```bash
kctl-n8n skill generate                 # install n8n-admin SKILL.md to ~/.claude/skills/
kctl-n8n skill install-mcp-skills       # install all 7 workflow-building skills
kctl-n8n skill list                     # show what's installed
```
