aspire terminal tape play command

このコンテンツはまだ日本語訳がありません。

Name

aspire terminal tape play - Play a tape file against an existing resource terminal.

Synopsis

aspire terminal tape play <resource> --tape-file <path> [options]

Description

The command parses a .tape file, discovers a running AppHost, selects a live terminal replica, validates the tape, and plays it against that terminal. The resource must be registered with WithTerminal(), and the AppHost must advertise the terminals.v1 capability.

Playback connects as a secondary peer. It doesn’t request primary ownership, resize the terminal, start a new shell, or stop the resource on completion or failure. Input remains shared with other connected peers; coordinate playback with dashboard and CLI users.

An empty or comment-only tape reads the current screen. If the selected replica has no live terminal producer yet, playback waits for one within --timeout, including during startup or recycling. The command doesn’t start or restart the resource. AppHost-owned dock and interaction terminals, including clients opened by WithRepl(), aren’t resource targets for this command.

See Tape file syntax for supported commands and compatibility limits. Unsupported media, clipboard, scrolling, sizing, and shell-launch settings fail preflight before any tape input is sent.

Arguments

<resource>

The name of the terminal-enabled resource to automate.

Options

--tape-file <path> (required)

Path to the tape on the CLI machine. Relative paths resolve from the CLI’s working directory.
-r, --replica <index>

The zero-based terminal replica index. A single replica is selected automatically. With multiple replicas, the CLI prompts for a choice unless you supply this option; non-interactive playback requires an explicit selection.
--apphost <path>

Path to the AppHost used to select a running application. --project is a legacy alias. This option doesn’t start the AppHost.
--timeout <seconds>

Overall timeout for waiting for a live terminal producer, connecting, and playing the tape. Defaults to 120 seconds; accepts integers from 1 through 4294967. The deadline starts after resource selection, so it doesn’t bound initial AppHost discovery. Recording finalization and cleanup may continue after cancellation. Individual tape waits can have shorter timeouts.
-?, -h, --help

Prints help and usage documentation for the available commands and options.
-l, --log-level <Critical|Debug|Error|Information|None|Trace|Warning>

Set the minimum log level for console output. Use this option to increase diagnostics while troubleshooting or reduce output in scripted runs.
--non-interactive

Run the command in non-interactive mode, disabling all interactive prompts and spinners.
--nologo

Suppress the startup banner and telemetry notice.
--banner

Display the animated Aspire CLI welcome banner.
--wait-for-debugger

Wait for a debugger to attach before running a command.

Output and exit codes

The final plain-text screen is written to stdout. Discovery messages, warnings, and diagnostics are written to stderr. A failed tape command also prints its failure screen to stdout, with the source location and command context on stderr.

Exit code	Meaning
`0`	The tape completed. This doesn’t assert that every program invoked inside a shell succeeded.
`1`	Invalid input, tape syntax, preflight validation, or resource selection.
`16`	Tape command failure, including a wait failure, or a terminal connection failure.
`17`	The overall `--timeout` deadline expired.
`130`	User cancellation.

AppHost discovery and compatibility errors use their corresponding CLI exit codes. A disconnected terminal fails playback instead of retrying potentially non-idempotent input.

Use Output recording.txt or Output recording.ascii in the root tape to record per-command text screens. This differs from stdout’s final screen. Output and Source paths resolve relative to the root tape file’s directory, including directives in nested sources. Included sources require the exact .tape extension; their Output directives are ignored. Output parent directories must exist, and existing recording files aren’t overwritten.

Examples

Use the complete shell smoke test and resource setup to create shell-smoke.tape and start the shell resource:

aspire terminal tape play shell --tape-file shell-smoke.tape

To select an AppHost explicitly and bound playback to 30 seconds, use your AppHost’s path:

aspire terminal tape play shell --replica 0 --tape-file shell-smoke.tape --apphost ./apphost.cs --timeout 30

Save the final screen and diagnostics separately:

aspire terminal tape play shell --tape-file shell-smoke.tape > final-screen.txt 2> tape-diagnostics.txt

Shell redirection can overwrite files independently of tape Output protections. For a multi-screen recording, follow Record screens as text.