docs(execute): note print-width/column handling and deferred --width (JG-04)#51
Conversation
…(JG-04) Print-width fidelity was already correct (mac-telnet/ssh captured at a wide screen so columns don't wrap; REST/native return structured records unaffected), but it was undocumented at the user-facing surface. Add a README bullet stating the behavior and that an explicit `--width` knob is deferred until needed. No code change. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Warning Review limit reached
More reviews will be available in 42 minutes and 28 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Pull request overview
Updates the execute command documentation to clarify how RouterOS print output width/wrapping interacts with different transports, and why there is no --width flag today.
Changes:
- Documented
printwidth / column-wrapping behavior (JG-04) across mac-telnet, SSH, REST, and native API. - Clarified that explicit per-call width overrides are intentionally deferred.
| - **Print width / column wrapping (JG-04).** RouterOS wraps `print` output to the | ||
| terminal width over a console transport. centrs captures mac-telnet and SSH at | ||
| a deliberately tall/wide screen (`src/protocols/mac-telnet-console.ts` answers | ||
| the device's size probe with a large terminal), so captured columns are neither | ||
| wrapped nor paginated. REST and native-api return structured records, so | ||
| terminal width does not apply to them at all. There is therefore no per-call | ||
| `--width` knob today — an explicit width override is deferred until a concrete | ||
| need appears. |
…th wording Distinguish the three mechanisms instead of attributing one "wide screen" to all: mac-telnet answers the device's terminal-size probe; SSH execute runs with no pseudo-tty so RouterOS emits nothing terminal-wrapped; REST/native-api are not consoles (structured records or a string `ret`), so width never applies. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
@coderabbitai review |
✅ Action performedReview finished.
|
What
JG-04 fidelity: print-width handling was already correct but undocumented at the
user-facing surface. Adds one
commands/execute/README.mdbullet:(
src/protocols/mac-telnet-console.tsanswers the device's size probe with alarge terminal), so captured columns are neither wrapped nor paginated.
--widthknob today; an explicit width overrideis deferred until a concrete need appears.
Documentation only — no code change. Status surface (MATRIX) unchanged.
Verification
bun run lint+bun run lint:ci(markdownlint) green.🤖 Generated with Claude Code