Command Reference

To see all commands in Nushell, run help commands.

Command	Categories	Description
agg	lazyframe	Performs a series of aggregations from a group-by
agg-groups	expression	creates an agg_groups expression
alias	core	Alias a command (with optional flags) to a new name
all	filters	Test if every element of the input fulfills a predicate expression.
all-false	dataframe	Returns true if all values are false
all-true	dataframe	Returns true if all values are true
and	database db-expression	Includes an AND clause for a query Includes an AND clause for an expression
ansi	platform	Output ANSI codes to change color.
ansi gradient	platform	Draw text with a provided start and end code making a gradient
ansi strip	platform	Strip ANSI escape sequences from a string
any	filters	Tests if any element of the input fulfills a predicate expression.
append	dataframe filters	Appends a new dataframe Append any number of rows to a table.
arg-max	dataframe	Return index for max value in series
arg-min	dataframe	Return index for min value in series
arg-sort	dataframe	Returns indexes for a sorted series
arg-true	dataframe	Returns indexes where values are true
arg-unique	dataframe	Returns indexes for unique values
arg-where	expression	Creates an expression that returns the arguments where expression is true
as	database db-expression expression	Creates an alias for a column selection Creates an alias for a column selection Creates an alias expression
as-date	dataframe	Converts string to date.
as-datetime	dataframe	Converts string to datetime.
ast	core	Print the abstract syntax tree (ast) for a pipeline.
benchmark	system	Time the running time of a block
bits	bits	Various commands for working with bits
bits and	bits	Performs bitwise and for integers
bits not	bits	Performs logical negation on each bit
bits or	bits	Performs bitwise or for integers
bits rol	bits	Bitwise rotate left for integers
bits ror	bits	Bitwise rotate right for integers
bits shl	bits	Bitwise shift left for integers
bits shr	bits	Bitwise shift right for integers
bits xor	bits	Performs bitwise xor for integers
build-string	strings	Create a string from the arguments.
bytes	bytes	Various commands for working with byte data
bytes add	bytes	Add specified bytes to the input
bytes at	bytes	Get bytes defined by a range. Note that the start is included but the end is excluded, and that the first byte is index 0.
bytes build	bytes	Create bytes from the arguments.
bytes collect	bytes	Concatenate multiple binary into a single binary, with an optional separator between each
bytes ends-with	bytes	Check if bytes ends with a pattern
bytes index-of	bytes	Returns start index of first occurrence of pattern in bytes, or -1 if no match
bytes length	bytes	Output the length of any bytes in the pipeline
bytes remove	bytes	Remove bytes
bytes replace	bytes	Find and replace binary
bytes reverse	bytes	Reverse every bytes in the pipeline
bytes starts-with	bytes	Check if bytes starts with a pattern
cache	lazyframe	Caches operations in a new LazyFrame
cal	generators	Display a calendar.
cd	filesystem	Change directory.
char	strings	Output special characters (e.g., 'newline').
clear	platform	Clear the terminal.
col	expression	Creates a named column expression
collect	database filters lazyframe	Collects a query from a database database connection Collect the stream and pass it to a block. Collect lazy dataframe into eager dataframe
columns	dataframe filters	Show dataframe columns Show the columns in the input.
commandline	core	View or modify the current command line input buffer
compact	filters	Creates a table with non-empty rows.
complete	system	Complete the external piped in, collecting outputs and exit code
concat-str	expression	Creates a concat string expression
concatenate	dataframe	Concatenates strings with other array
config	env	Edit nushell configuration files
config env	env	Edit nu environment configurations
config nu	env	Edit nu configurations
config reset	env	Reset nushell environment configurations to default, and saves old config files in the config location as oldconfig.nu and oldenv.nu
contains	dataframe	Checks if a pattern is contained in a string
count	expression	creates a count expression
count-null	dataframe	Counts null values
cp	filesystem	Copy files.
cumulative	dataframe	Cumulative calculation for a series
date	date	Date-related commands
date format	date	Format a given date using a format string.
date humanize	date	Print a 'humanized' format for the date, relative to now.
date list-timezone	date	List supported time zones.
date now	date	Get the current date.
date to-record	date	Convert the date into a structured table.
date to-table	date	Convert the date into a structured table.
date to-timezone	date	Convert a date to a given time zone.
debug	core	Debug print the value(s) piped in.
decode	strings	Decode bytes as a string.
decode base64	hash	Base64 decode a value
def	core	Define a custom command
def-env	core	Define a custom command, which participates in the caller environment
default	filters	Sets a default row's column if missing.
describe	core database dataframe	Describe the type and structure of the value(s) piped in. Describes connection and query of the DB object Describes dataframes numeric columns
detect columns	strings	Attempt to automatically split text into multiple columns
df-not	dataframe	Inverts boolean mask
do	core	Run a block
drop	dataframe filters	Creates a new dataframe by dropping the selected columns Remove the last several rows of the input. Counterpart of 'skip'. Opposite of 'last'.
drop column	filters	Remove the last number of columns. If you want to remove columns by name, try 'reject'.
drop nth	filters	Drop the selected rows.
drop-duplicates	dataframe	Drops duplicate values in dataframe
drop-nulls	dataframe	Drops null values in dataframe
dtypes	dataframe	Show dataframe data types
du	core	Find disk usage sizes of specified items.
dummies	dataframe	Creates a new dataframe with dummy variables
each	filters	Run a block on each row of input
each while	filters	Run a block on each element of input until a null is found
echo	core	Returns its arguments, ignoring the piped-in value.
encode	strings	Encode an UTF-8 string into other kind of representations.
encode base64	hash	Base64 encode a value
enter	shells	Enters a new shell at the given path.
env	env	Display current environment variables
error make	core	Create an error.
every	filters	Show (or skip) every n-th row, starting from the first one.
exec	system	Execute a command, replacing the current process.
exit	shells	Exit a Nu shell or exit Nu entirely.
explode	expression	creates an explode expression
export	core	Export definitions or environment variables from a module.
export alias	core	Define an alias and export it from a module
export def	core	Define a custom command and export it from a module
export def-env	core	Define a custom command that participates in the environment and export it from a module
export extern	core	Define an extern and export it from a module
export use	core	Use definitions from a module and export them from this module
export-env	env	Run a block and preserve its environment in a current scope.
expr-not	expression	creates a not expression
extern	core	Define a signature for an external command
fetch	lazyframe network	collects the lazyframe to the selected rows Fetch the contents from a URL.
field	db-expression	Creates column expression for database
fill-na	lazyframe	Replaces NA values with the given expression
fill-null	lazyframe	Replaces NULL values with the given expression
filter	lazyframe	Filter dataframe based in expression
filter-with	dataframe or lazyframe	Filters dataframe using a mask or expression as reference
find	filters	Searches terms in the input or for elements of the input that satisfies the predicate.
first	dataframe expression filters	Show only the first number of rows. creates a first expression Return only the first several rows of the input. Counterpart of 'last'. Opposite of 'skip'.
flatten	expression filters	creates a flatten expression Flatten the table.
fmt	conversions	Format a number
fn	db-expression	Creates function expression for a select operation
for	core	Loop over a range
format	strings	Format columns into a string using a simple pattern.
format filesize	strings	Converts a column of filesizes to some specified format
from	formats	Parse a string or binary data into structured data
from csv	formats	Parse text as .csv and create table.
from eml	formats	Parse text as .eml and create table.
from ics	formats	Parse text as .ics and create table.
from ini	formats	Parse text as .ini and create table
from json	formats	Convert from json to structured data
from nuon	experimental	Convert from nuon to structured data
from ods	formats	Parse OpenDocument Spreadsheet(.ods) data and create table.
from ssv	formats	Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2.
from table	database	Select section from query statement for a DB
from toml	formats	Parse text as .toml and create table.
from tsv	formats	Parse text as .tsv and create table.
from url	formats	Parse url-encoded string as a table.
from vcf	formats	Parse text as .vcf and create table.
from xlsx	formats	Parse binary Excel(.xlsx) data and create table.
from xml	formats	Parse text as .xml and create table.
from yaml	formats	Parse text as .yaml/.yml and create table.
from yml	formats	Parse text as .yaml/.yml and create table.
g	shells	Switch to a given shell, or list all shells if no given shell number.
get	dataframe filters	Creates dataframe with the selected columns Extract data using a cell path.
get-day	dataframe	Gets day from date
get-hour	dataframe	Gets hour from date
get-minute	dataframe	Gets minute from date
get-month	dataframe	Gets month from date
get-nanosecond	dataframe	Gets nanosecond from date
get-ordinal	dataframe	Gets ordinal from date
get-second	dataframe	Gets second from date
get-week	dataframe	Gets week from date
get-weekday	dataframe	Gets weekday from date
get-year	dataframe	Gets year from date
glob	filesystem	Creates a list of files and/or folders based on the glob pattern provided.
grid	viewers	Renders the output to a textual terminal grid.
group	filters	Groups input into groups of `group_size`.
group-by	database default lazyframe	Group-by query Split a table into groups based on one column's values, and return a record with those groups. Creates a group-by object that can be used for other aggregations
gstat	prompt	Get the git status of a repo
hash	hash	Apply hash function.
hash base64	deprecated	Deprecated command
hash md5	default	Hash a value using the md5 hash algorithm
hash sha256	default	Hash a value using the sha256 hash algorithm
headers	filters	Use the first row of the table as column names.
help	core	Display help information about commands.
hide	core	Hide definitions in the current scope
hide-env	core	Hide environment variables in the current scope
histogram	default	Creates a new table with a histogram based on the column name passed in.
history	misc	Get the command history
history session	misc	Get the command history session
if	core	Conditionally run a block.
ignore	core	Ignore the output of the previous command in the pipeline
inc	default	Increment a value or version. Optionally use the column of a table.
input	platform	Get input from the user.
insert	filters	Insert a new column.
into	conversions	Commands to convert data from one type to another.
into binary	conversions	Convert value to a binary primitive
into bool	conversions	Convert value to boolean
into datetime	conversions	Convert text into a datetime
into db	database	Converts the input into an open db connection
into decimal	default	Convert text into a decimal
into df	dataframe	Converts a list, table or record into a dataframe
into duration	conversions	Convert value to duration
into filesize	conversions	Convert value to filesize
into int	conversions	Convert value to integer
into lazy	lazyframe	Converts a dataframe into a lazy dataframe
into nu	dataframe db-expression expression	Converts a section of the dataframe into nushell Table Convert a db expression into a nu value for access and exploration Convert expression into a nu value for access and exploration
into sqlite	conversions	Convert table into a sqlite database
into string	conversions	Convert value to string
is-admin	core	Check if nushell is running with administrator or root privileges
is-duplicated	dataframe	Creates mask indicating duplicated values
is-empty	filters	Check for empty values.
is-in	dataframe expression	Checks if elements from a series are contained in right series Creates an is-in expression
is-not-null	dataframe expression	Creates mask where value is not null creates a is not null expression
is-null	dataframe expression	Creates mask where value is null creates a is null expression
is-unique	dataframe	Creates mask indicating unique values
join	database lazyframe	Joins with another table or derived table. Default join type is inner Joins a lazy frame with other lazy frame
keybindings	platform	Keybindings related commands
keybindings default	platform	List default keybindings
keybindings list	platform	List available options that can be used to create keybindings
keybindings listen	platform	Get input from the user.
kill	platform	Kill a process using the process id.
last	dataframe expression filters	Creates new dataframe with tail rows or creates a last expression creates a last expression Return only the last several rows of the input. Counterpart of 'first'. Opposite of 'drop'.
length	filters	Count the number of elements in the input.
let	core	Create a variable and give it a value.
let-env	env	Create an environment variable and give it a value.
limit	database	Limit result from query
lines	filters	Converts input to lines
list	expression	Aggregates a group to a Series
lit	expression	Creates a literal expression
load-env	filesystem	Loads an environment update from a record.
lowercase	dataframe	Lowercase the strings in the column
ls	filesystem	List the files in a directory.
ls-df	dataframe	Lists stored dataframes
math	math	Use mathematical functions as aggregate functions on a list of numbers or tables.
math abs	math	Returns absolute values of a list of numbers
math avg	math	Finds the average of a list of numbers or tables
math ceil	math	Applies the ceil function to a list of numbers
math eval	math	Evaluate a math expression into a number
math floor	math	Applies the floor function to a list of numbers
math max	math	Finds the maximum within a list of numbers or tables
math median	math	Gets the median of a list of numbers
math min	math	Finds the minimum within a list of numbers or tables
math mode	math	Gets the most frequent element(s) from a list of numbers or tables
math product	math	Finds the product of a list of numbers or tables
math round	math	Applies the round function to a list of numbers
math sqrt	math	Applies the square root function to a list of numbers
math stddev	math	Finds the stddev of a list of numbers or tables
math sum	math	Finds the sum of a list of numbers or tables
math variance	math	Finds the variance of a list of numbers or tables
max	expression lazyframe	Creates a max expression Aggregates columns to their max value
mean	expression lazyframe	Creates a mean expression for an aggregation Aggregates columns to their mean value
median	expression lazyframe	Creates a median expression for an aggregation Aggregates columns to their median value
melt	dataframe	Unpivot a DataFrame from wide to long format
merge	filters	Merge the input with a record or table, overwriting values in matching columns.
metadata	core	Get the metadata for items in the stream
min	expression lazyframe	Creates a min expression Aggregates columns to their min value
mkdir	filesystem	Make directories, creates intermediary directories as required.
module	core	Define a custom module
move	filters	Move columns before or after other columns
mv	filesystem	Move files or directories.
n	shells	Switch to the next shell.
n-unique	dataframe expression	Counts unique values creates a n-unique expression
nu-check	strings	Validate and parse input content
nu-highlight	strings	Syntax highlight the input string.
open	filesystem	Load a file into a cell, converting to table if possible (avoid by appending '--raw').
open-db	database	Open a database
open-df	dataframe	Opens csv, json, arrow, or parquet file to create dataframe
or	database db-expression	Includes an OR clause for a query Includes an OR clause for an expression
order-by	database	Orders by query
otherwise	expression	completes a when expression
over	db-expression	Adds a partition to an expression function
overlay	core	Commands for manipulating overlays.
overlay hide	core	Hide an active overlay
overlay list	core	List all active overlays
overlay new	core	Create an empty overlay
overlay use	core	Use definitions from a module as an overlay
p	shells	Switch to the previous shell.
par-each	filters	Run a block on each element of input in parallel
parse	strings	Parse columns from string data using a simple pattern.
path	default	Explore and manipulate paths.
path basename	default	Get the final component of a path
path dirname	default	Get the parent directory of a path
path exists	default	Check whether a path exists
path expand	default	Try to expand a path to its absolute form
path join	default	Join a structured path or a list of path parts.
path parse	default	Convert a path into structured data.
path relative-to	default	Get a path as relative to another path.
path split	default	Split a path into a list based on the system's path separator.
path type	default	Get the type of the object a path refers to (e.g., file, dir, symlink)
port	network	Get a free port from system
post	network	Post a body to a URL.
prepend	filters	Prepend any number of rows to a table.
print	strings	Print the given values to stdout
ps	system	View information about system processes.
quantile	expression lazyframe	Aggregates the columns to the selected quantile Aggregates the columns to the selected quantile
query	filters	Show all the query commands
query db	database	Query a database using SQL.
query df	dataframe	Query dataframe using SQL. Note: The dataframe is always named 'df' in your query's from clause.
query json	filters	execute json query on json file (open --raw <file> | query json 'query string')
query web	network	execute selector query on html/web
query xml	filters	execute xpath query on xml
random	random	Generate a random value.
random bool	random	Generate a random boolean value
random chars	random	Generate random chars
random decimal	random	Generate a random decimal within a range [min..max]
random dice	random	Generate a random dice roll
random integer	random	Generate a random integer [min..max]
random uuid	random	Generate a random uuid4 string
range	filters	Return only the selected rows.
reduce	default	Aggregate a list table to a single value using an accumulator block.
register	core	Register a plugin
reject	filters	Remove the given columns from the table. If you want to remove rows, try 'drop'.
rename	dataframe or lazyframe filters	Rename a dataframe column Creates a new table with columns renamed.
replace	dataframe	Replace the leftmost (sub)string by a regex pattern
replace-all	dataframe	Replace all (sub)strings by a regex pattern
reverse	filters lazyframe	Reverses the table. Reverses the LazyFrame
rm	filesystem	Remove file(s).
roll	filters	Rolling commands for tables
roll down	filters	Roll table rows down
roll left	filters	Roll table columns left
roll right	filters	Roll table columns right
roll up	filters	Roll table rows up
rolling	dataframe	Rolling calculation for a series
rotate	filters	Rotates a table clockwise (default) or counter-clockwise (use --ccw flag).
run-external	system	Runs external command
sample	dataframe	Create sample dataframe
save	filesystem	Save a file.
schema	database	Show sqlite database information, including its schema.
select	database filters lazyframe	Creates a select statement for a DB Down-select table to only these columns. Selects columns from lazyframe
seq	generators	Print sequences of numbers.
seq char	generators	Print sequence of chars
seq date	generators	Print sequences of dates
set	dataframe	Sets value where given mask is true
set-with-idx	dataframe	Sets value in the given index
shape	dataframe	Shows column and row size for a dataframe
shells	shells	Lists all open shells.
shift	dataframe or lazyframe	Shifts the values by a given period
shuffle	filters	Shuffle rows randomly.
size	strings	Gather word count statistics on the text.
skip	filters	Skip the first several rows of the input. Counterpart of 'drop'. Opposite of 'first'.
skip until	filters	Skip elements of the input until a predicate is true.
skip while	filters	Skip elements of the input while a predicate is true.
sleep	platform	Delay for a specified amount of time.
slice	dataframe	Creates new dataframe from a slice of rows
sort	filters	Sort in increasing order.
sort-by	filters lazyframe	Sort by the given columns, in increasing order. sorts a lazy dataframe based on expression(s)
source	core	Runs a script file in the current context.
source-env	core	Source the environment from a source file into the current environment.
split	strings	Split contents across desired subcommand (like row, column) via the separator.
split chars	strings	Split a string's characters into separate rows
split column	strings	Split a string into multiple columns using a separator
split list	filters	Split a list into multiple lists using a separator
split row	strings	Split a string into multiple rows using a separator
split words	strings	Split a string's words into separate rows
split-by	default	Create a new table splitted.
std	expression lazyframe	Creates a std expression for an aggregation Aggregates columns to their std value
str	strings	Various commands for working with string data
str camel-case	strings	Convert a string to camelCase
str capitalize	strings	Capitalize first letter of text
str collect	deprecated	'str collect' is deprecated. Please use 'str join' instead.
str contains	strings	Checks if input contains string
str distance	strings	compare two strings and return the edit distance/levenshtein distance
str downcase	strings	Make text lowercase
str ends-with	strings	Check if an input ends with a string
str find-replace	deprecated	Deprecated command
str index-of	strings	Returns start index of first occurrence of string in input, or -1 if no match
str join	strings	Concatenate multiple strings into a single string, with an optional separator between each
str kebab-case	strings	Convert a string to kebab-case
str length	strings	Output the length of any strings in the pipeline
str lpad	strings	Left-pad a string to a specific length
str pascal-case	strings	Convert a string to PascalCase
str replace	strings	Find and replace text
str reverse	strings	Reverse every string in the pipeline
str rpad	strings	Right-pad a string to a specific length
str screaming-snake-case	strings	Convert a string to SCREAMING_SNAKE_CASE
str snake-case	strings	Convert a string to snake_case
str starts-with	strings	Check if an input starts with a string
str substring	default	Get part of a string. Note that the start is included but the end is excluded, and that the first character of a string is index 0.
str title-case	strings	Convert a string to Title Case
str to-datetime	deprecated	Deprecated command
str to-decimal	deprecated	Deprecated command
str to-int	deprecated	Deprecated command
str trim	default	Trim whitespace or specific character
str upcase	default	Make text uppercase
str-lengths	dataframe	Get lengths of all strings
str-slice	dataframe	Slices the string from the start position until the selected length
strftime	dataframe	Formats date based on string rule
sum	expression lazyframe	Creates a sum expression for an aggregation Aggregates columns to their sum value
sys	system	View information about the system.
table	viewers	Render the table.
take	dataframe filters	Creates new dataframe using the given indices Take only the first n elements.
take until	filters	Take elements of the input until a predicate is true.
take while	filters	Take elements of the input while a predicate is true.
term size	platform	Returns a record containing the number of columns (width) and rows (height) of the terminal
testing-db	database	Temporal Command: Create query object
to	formats	Translate structured data to a format
to arrow	dataframe	Saves dataframe to arrow file
to csv	dataframe formats	Saves dataframe to csv file Convert table into .csv text
to html	formats	Convert table into simple HTML
to json	formats	Converts table data into JSON text.
to md	formats	Convert table into simple Markdown
to nuon	experimental	Converts table data into Nuon (Nushell Object Notation) text.
to parquet	dataframe	Saves dataframe to parquet file
to text	formats	Converts data into simple text.
to toml	formats	Convert table into .toml text
to tsv	formats	Convert table into .tsv text
to url	formats	Convert table into url-encoded text
to xml	formats	Convert table into .xml text
to yaml	formats	Convert table into .yaml/.yml text
touch	filesystem	Creates one or more files.
transpose	default	Transposes the table contents so rows become columns and columns become rows.
tutor	misc	Run the tutorial. To begin, run: tutor
uniq	filters	Return the distinct values in the input.
unique	dataframe or lazyframe	Returns unique values from a dataframe
update	filters	Update an existing column to have a new value.
update cells	filters	Update the table cells.
uppercase	dataframe	Uppercase the strings in the column
upsert	filters	Update an existing column to have a new value, or insert a new column.
url	network	Apply url function.
url host	network	Get the host of a URL
url path	network	Get the path of a URL
url query	network	Get the query string of a URL
url scheme	network	Get the scheme (e.g. http, file) of a URL
use	core	Use definitions from a module
value-counts	dataframe	Returns a dataframe with the counts for unique values in series
var	expression lazyframe	Create a var expression for an aggregation Aggregates columns to their var value
version	default	Display Nu version.
view-source	core	View a block, module, or a definition
watch	filesystem	Watch for file changes and execute Nu code when they happen.
when	expression	Creates and modifies a when expression
where	database filters	Includes a where statement for a query Filter values based on a condition.
which	system	Finds a program file, alias or custom command.
window	filters	Creates a sliding window of `window_size` that slide by n rows/elements across input.
with-column	dataframe or lazyframe	Adds a series to the dataframe
with-env	env	Runs a block with an environment variable set.
wrap	filters	Wrap the value into a column.
zip	filters	Combine a stream with the input