Skip to content

docs(te-cli): document interactive piped/non-interactive stdin, comments, and --no-banner/--echo/--batch/--no-batch#355

Open
MariaJoseFF wants to merge 1 commit into
cli/pupr-milestone2-releasefrom
user-mjf/docs-te-cli-interactive-piped-stdin
Open

docs(te-cli): document interactive piped/non-interactive stdin, comments, and --no-banner/--echo/--batch/--no-batch#355
MariaJoseFF wants to merge 1 commit into
cli/pupr-milestone2-releasefrom
user-mjf/docs-te-cli-interactive-piped-stdin

Conversation

@MariaJoseFF

Copy link
Copy Markdown
Collaborator

Summary

The interactive REPL (te interactive) gained piped / non-interactive input handling in Milestone 2. These features appear in te interactive --help but were undocumented. This PR documents them on the Interactive Mode page.

Targets the cli/pupr-milestone2-release branch (Milestone 2 / Public Preview docs collection), not main.

What was added

A new Piped and redirected input section on content/features/te-cli/te-cli-interactive.md, covering:

  • Driving the REPL from piped or redirected stdin - each line runs as a command (bash/git-bash, Windows cmd.exe, and < script.te forms).
  • Lines starting with # are treated as comments and skipped.
  • Batch mode and exit codes: --batch is the default when stdin is piped (stops at the first failing command and exits non-zero); --no-batch continues past errors. Exit code is 0 on a clean run, non-zero on failure under batch mode.
  • --echo echoes each input line to stdout for readable transcripts (comment lines are not echoed).
  • An options reference table for --no-banner, --echo, --batch, --no-batch (descriptions verbatim from --help).
  • A Welcome banner vs. preview notice subsection clarifying that --no-banner suppresses only the interactive welcome banner (no effect when piped, since no banner is emitted), while the separate preview-expiry notice is written to stderr and suppressed via te config set hidePreviewNotice true.

Verification

All documented examples and behaviors were sanity-checked against te.exe 0.5.2.12402, including the cmd.exe pipe form and the batch-mode exit codes.

Notes

  • English page only; the localizedContent/es and /zh copies are intentionally untouched (translations handled separately).
  • Bumped the page front-matter updated: date.

Document the Milestone 2 features for driving the interactive REPL from
piped or redirected stdin, which exist in te interactive --help but were
absent from the docs:

- Piped/redirected stdin runs each line as a command (bash, cmd.exe, < file)
- Lines starting with # are comments and skipped
- --batch is the default when stdin is piped (stop + exit non-zero on first
  failure); --no-batch continues past errors
- --echo echoes each input line for readable transcripts
- Clarify --no-banner (welcome banner) vs. the stderr preview-expiry notice
  suppressed via te config set hidePreviewNotice true

Verified against te.exe 0.5.2.12402.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@MariaJoseFF MariaJoseFF requested a review from gronnerup June 26, 2026 07:22
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