Read-Host

Verb: ReadChapter 4: Formatting, input, and output display

Asks the user for input and returns it as text.

Syntax

Short syntax for this command. The parameter table below may list more parameters than this short line shows.

Syntax
Read-Host [-Prompt <Text>]

Parameters

Note: the short syntax above does not show every parameter in this table. The rows marked No in the last column are still listed here with their descriptions. Check Get-Help for the full syntax before you use one of them.

ParameterWhat it doesIn short syntax
-Promptthe question to askYes
-AsSecureStringhide the input, for passwordsNo

Examples

Asks for a name and stores it.

Example 1
$name = Read-Host "Enter a name"

Illustrative output: see the lesson example for this command.

Common mistakes

General cautions for this command.

  • Guessing parameters instead of checking Get-Help for this command.
  • Running a changing form of this command before previewing its effect.

Related commands

Commands that share this command's lesson come first, then commands that share its verb. Every link goes to a real command page.

Related lessons