Command Prompt

The command shortcode generates terminal output for either Bash, PowerShell, or SQL shell languages.

Overview

The command shortcode generates terminal output for either bash, powershell, or sql shell languages.

Arguments

The shortcode supports the following arguments:

ArgumentRequiredDescription
userNoOptional user to add to the prompt, e.g. “user”.
hostNoOptional host to add to the prompt, e.g. “localhost”.
promptNoOptional prompt override, e.g. “PS C:\Users\User>”.
shellNoType of shell, either “bash” (default), “powershell”, or “sql”.

Examples

Bash (default shell)

Use the command shortcode to generate a block with a default bash command prompt.

export MY_VAR=123
markdown
{{< command >}}
export MY_VAR=123
{{< /command >}}

Specify user and host to add the user context to the prompt. In addition, use (out) to specify an output line and use \ to denote a line continuation.

export MY_VAR=123
echo "hello"
hello
echo one \
two \
three
one two three
echo "goodbye"
goodbye
markdown
{{< command user="user" host="localhost" >}}
export MY_VAR=123
echo "hello"
(out)hello
echo one \
two \
three
(out)one two three
echo "goodbye"
(out)goodbye
{{< /command >}}

PowerShell

Set the shell argument to powershell to generate a PowerShell terminal. Override the prompt to add a directory if needed. Use the backtick ` symbol to denote a line continuation.

Write-Host `
'Hello' `
'from' `
'PowerShell!'
Hello from PowerShell!
Write-Host 'Goodbye from PowerShell!'
Goodbye from PowerShell!
markdown
{{< command prompt="PS C:\Users\User>" shell="powershell" >}}
Write-Host `
'Hello' `
'from' `
'PowerShell!'
(out)Hello from PowerShell!
Write-Host 'Goodbye from PowerShell!'
(out)Goodbye from PowerShell!
{{< /command >}}

SQL

Set the shell argument to sql to generate a SQL terminal. Use the (con) suffix to denote a line continuation.

set @my_var = 'foo';
set @my_other_var = 'bar';
CREATE TABLE people (
first_name VARCHAR(30) NOT NULL,
last_name VARCHAR(30) NOT NULL
);
Query OK, 0 rows affected (0.09 sec)
insert into people
values ('John', 'Doe');
Query OK, 1 row affected (0.02 sec)
select *
from people
order by last_name;
+------------+-----------+
| first_name | last_name |
+------------+-----------+
| John       | Doe       |
+------------+-----------+
1 row in set (0.00 sec)
markdown
{{< command prompt="mysql>" shell="sql" >}}
set @my_var = 'foo';
set @my_other_var = 'bar';
CREATE TABLE people ((con)
first_name VARCHAR(30) NOT NULL,(con)
last_name VARCHAR(30) NOT NULL(con)
);
(out)Query OK, 0 rows affected (0.09 sec)
insert into people(con)
values ('John', 'Doe');
(out)Query OK, 1 row affected (0.02 sec)
select *(con)
from people(con)
order by last_name;
(out)+------------+-----------+
(out)| first_name | last_name |
(out)+------------+-----------+
(out)| John       | Doe       |
(out)+------------+-----------+
(out)1 row in set (0.00 sec)
{{< /command >}}
Last updated: February 12, 2023 • Upgrade to docs v0.9 (2caaad8)