Skip to content

docs: document n8nctl version, data table, and admin commands - #136

Merged
Hinne1 merged 7 commits into
mainfrom
claude/n8nctl-api-coverage-docs
Oct 13, 2026
Merged

Hinne1 merged 7 commits into
mainfrom
claude/n8nctl-api-coverage-docs

Conversation

@Hinne1

@Hinne1 Hinne1 commented Oct 13, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds the commands from enthus-appdev/n8n-cli#23 to the injected cli-n8nctl.md agent doc: workflow versions and publishing, execution stop, data tables, credentials, tags, folders, users, project members, and audit. It also adds two safety notes. A push to a published workflow publishes immediately, and adding a project member changes access, so agents confirm it with the user first.

The commands only exist once n8n-cli#23 merges and a release is tagged. This PR is independent of #135; both edit the same doc block, so whichever merges second needs a small rebase.

Testing

  • npm test (6/6), eslint and prettier --check on lib/llm/index.js are clean.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the n8nctl CLI documentation in lib/llm/index.js to include details on workflow versions, data tables, credentials, tags, folders, users, and audit commands, along with new aliases. Feedback was provided to avoid using slash and pipe characters as separators inside the bash code block, as these can confuse LLM agents or lead to invalid shell pipe execution; instead, it is recommended to list a single valid command per line and document alternative subcommands in comments.

Comment thread lib/llm/index.js Outdated
@Hinne1
Hinne1 force-pushed the claude/n8nctl-api-coverage-docs branch from 8757613 to 65056e1 Compare October 13, 2026 11:59
@Hinne1 Hinne1 mentioned this pull request Oct 13, 2026
@Hinne1

Hinne1 commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the n8nctl documentation in lib/llm/index.js to include new sections for workflow versioning, execution control, data tables, and various management commands like credentials, tags, and folders. The review feedback suggests improving consistency in command placeholders by using '' instead of '' and clarifying the folder deletion command by using '' for the transfer destination.

Comment thread lib/llm/index.js Outdated
Comment thread lib/llm/index.js Outdated
@Hinne1
Hinne1 force-pushed the claude/n8nctl-api-coverage-docs branch from 65056e1 to 022b37c Compare October 13, 2026 12:44
@Hinne1

Hinne1 commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request expands the 'n8nctl' CLI documentation in 'lib/llm/index.js' to include sections on workflow versions and publishing, stopping executions, managing data tables, and handling credentials, tags, folders, users, and audits. Feedback suggests clarifying the syntax comment for reading from stdin in the data tables insert command, and adding a dedicated 'Safety Rules' section to ensure LLM agents request explicit user confirmation before performing destructive or access-changing operations.

Comment thread lib/llm/index.js Outdated
Comment thread lib/llm/index.js
@Hinne1

Hinne1 commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the n8nctl CLI documentation in lib/llm/index.js to include workflow versions and publishing, execution stopping, data tables, credentials, tags, folders, users, audits, and safety rules. The review feedback suggests adding workflow push to the safety-critical commands list in both safety rules sections, as well as documenting the project member set-role and project member remove commands which are referenced in the safety rules but currently missing from the command list.

Comment thread lib/llm/index.js Outdated
Comment thread lib/llm/index.js Outdated
Comment thread lib/llm/index.js
@Hinne1

Hinne1 commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the n8nctl CLI documentation in lib/llm/index.js to include new sections for workflow versions, stopping executions, data tables, credentials, tags, folders, users, and security audits. It also introduces safety rules requiring explicit confirmation before executing destructive operations on production instances. The review feedback suggests extending these safety rules to also cover variable delete and tag delete operations in both locations where the safety rules are defined.

Comment thread lib/llm/index.js Outdated
Comment thread lib/llm/index.js Outdated
@Hinne1

Hinne1 commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the n8nctl CLI documentation in lib/llm/index.js, adding comprehensive details on workflow versions, execution management, data tables, credentials, folders, and security audits. It also introduces safety rules requiring explicit user confirmation before executing destructive operations on production instances. The review feedback recommends extending these safety rules to include the workflow deactivate command, which is also highly disruptive, ensuring consistency across both safety rule definitions in the file.

Comment thread lib/llm/index.js Outdated
Comment thread lib/llm/index.js Outdated
@Hinne1

Hinne1 commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

🔏 Readiness attested — the pr-readiness-check gate completed for PR #136 at 1c58bfebc9cbd465de6bebe1d8d3d5e6f5bb5574 (2026-10-13T13:35:11Z). If the branch head has moved, this evidence covers the earlier state only.

Readiness summary

PR Readiness Check (#136, 1c58bfe)
Review mode INITIAL
Branch/base PASS (rebased on origin/main incl. #135 and v1.13.2, clean, head pushed)
Local verification PASS (npm test 6/6, eslint, prettier --check; rendered CLI_DOCS.n8nctl)
Remote CI PASS (NPM run 38405874334: Lint, Check format; CodeQL run 38405866383); DEFERRED UNTIL READY: License NPM / License Check; publish.yml excluded (release-triggered)
Coverage NOT REPORTED
Automated reviewers PASS with note (Gemini reviewed ce795d4; the final commit 1c58bfe applies Gemini's own suggested text verbatim, so no further retrigger)
Review threads PASS (11 Gemini threads across 5 reviews, all FIXED or REFUTED with evidence and resolved)
Review comments PASS (open-review-comments.sh exit 0)
Council findings SKIP (operator-waived: docs-only; lib/llm/index.js doc strings)
Standards review SKIP (same waiver)
Spec review SKIP (same waiver)
PR description PASS
SQL/UI evidence SKIP
Notes: adds a production-scoped n8nctl Safety rule to the global CLI Tools block. Documents commands that ship with n8n-cli#23; merge after #23 is released.
Result: READY

@Hinne1
Hinne1 marked this pull request as ready for review October 13, 2026 13:35
@Hinne1
Hinne1 merged commit 10c6ca8 into main Oct 13, 2026
7 checks passed
@Hinne1
Hinne1 deleted the claude/n8nctl-api-coverage-docs branch October 13, 2026 14:24
@Hinne1 Hinne1 mentioned this pull request Oct 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant