Skip to content

docs: document n8nctl source-control commands - #135

Merged
Hinne1 merged 2 commits into
mainfrom
claude/n8nctl-source-control-docs
Oct 13, 2026
Merged

Hinne1 merged 2 commits into
mainfrom
claude/n8nctl-source-control-docs

Conversation

@Hinne1

@Hinne1 Hinne1 commented Oct 13, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds the n8nctl source-control commands (status, push, pull) and the sc alias to the injected cli-n8nctl.md agent doc, with the safety notes agents need:

  • push targets only named items
  • a pull on a production instance is a production deploy
  • check a 409 before using --force
  • a 403 means a missing scope

Depends on enthus-appdev/n8n-cli#22 at runtime: the commands exist once that PR merges and a release is tagged. This PR only changes doc text, so it can merge independently.

Testing

  • npm test (6/6 pass), eslint and prettier --check on lib/llm/index.js are clean.
  • Rendered CLI_DOCS.n8nctl.content and checked the new section.

@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 commands, aliases, and details for source control (instance Git connection). The review feedback suggests expanding shorthand permission scopes like :push and :pull to their full names (sourceControl:push and sourceControl:pull) to avoid ambiguity for LLM agents.

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 documentation for the n8nctl CLI by adding a new section for source control features and including a new alias for the source-control command. The review feedback suggests standardizing the item types listed in the documentation to use singular forms for better consistency and alignment with CLI expectations.

Comment thread lib/llm/index.js
@Hinne1

Hinne1 commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

🔏 Readiness attested — the pr-readiness-check gate completed for PR #135 at 031984919461baf3f2eb63178a50991447ac7bd1 (2026-10-13T11:06:01Z). If the branch head has moved, this evidence covers the earlier state only.

Readiness summary

PR Readiness Check (#135, 0319849)
Review mode INITIAL
Branch/base PASS (contains origin/main, clean, head pushed)
Local verification PASS (npm test 6/6, eslint, prettier --check on lib/llm/index.js)
Remote CI PASS (NPM run 38384277768: Lint, Check format; CodeQL run 38384271905); DEFERRED UNTIL READY: License NPM / License Check (skips drafts; runs on ready_for_review); publish.yml excluded (release-triggered)
Coverage NOT REPORTED
Automated reviewers PASS (Gemini reviewed 0319849)
Review threads PASS (2 Gemini threads: 1 FIXED in 0319849, 1 REFUTED with CLI output; both resolved)
Review comments PASS (open-review-comments.sh exit 0)
Council findings SKIP (operator-waived: user asked to skip Council; doc-string-only diff)
Standards review SKIP (operator-waived with Council)
Spec review SKIP (operator-waived with Council)
PR description PASS
SQL/UI evidence SKIP (docs text)
Result: READY

@Hinne1
Hinne1 marked this pull request as ready for review October 13, 2026 11:06
@Hinne1
Hinne1 merged commit 157ebbc into main Oct 13, 2026
7 checks passed
@Hinne1
Hinne1 deleted the claude/n8nctl-source-control-docs branch October 13, 2026 11:55
@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