ContextQMD
Back to Fish

status - query fish runtime information¶

site/docs/3.1/cmds/status.html

latest3.2 KB
Original Source

status - query fish runtime information

Synopsis

statusstatus is-loginstatus is-interactivestatus is-blockstatus is-breakpointstatus is-command-substitutionstatus is-no-job-controlstatus is-full-job-controlstatus is-interactive-job-controlstatus current-commandstatus filenamestatus fish-pathstatus functionstatus line-numberstatus stack-tracestatus job-control CONTROL-TYPEstatus featuresstatus test-feature FEATURE

Description

With no arguments, status displays a summary of the current login and job control status of the shell.

The following operations (sub-commands) are available:

  • is-command-substitution returns 0 if fish is currently executing a command substitution. Also -c or --is-command-substitution.
  • is-block returns 0 if fish is currently executing a block of code. Also -b or --is-block.
  • is-breakpoint returns 0 if fish is currently showing a prompt in the context of a breakpoint command. See also the fish_breakpoint_prompt function.
  • is-interactive returns 0 if fish is interactive - that is, connected to a keyboard. Also -i or --is-interactive.
  • is-login returns 0 if fish is a login shell - that is, if fish should perform login tasks such as setting up the PATH. Also -l or --is-login.
  • is-full-job-control returns 0 if full job control is enabled. Also --is-full-job-control (no short flag).
  • is-interactive-job-control returns 0 if interactive job control is enabled. Also, --is-interactive-job-control (no short flag).
  • is-no-job-control returns 0 if no job control is enabled. Also --is-no-job-control (no short flag).
  • current-command prints the name of the currently-running function or command, like the deprecated _ variable.
  • filename prints the filename of the currently running script. Also current-filename, -f or --current-filename.
  • fish-path prints the absolute path to the currently executing instance of fish.
  • function prints the name of the currently called function if able, when missing displays "Not a function" (or equivalent translated string). Also current-function, -u or --current-function.
  • line-number prints the line number of the currently running script. Also current-line-number, -n or --current-line-number.
  • stack-trace prints a stack trace of all function calls on the call stack. Also print-stack-trace, -t or --print-stack-trace.
  • job-control CONTROL-TYPE sets the job control type, which can be none, full, or interactive. Also -j CONTROL-TYPE or --job-control=CONTROL-TYPE.
  • features lists all available feature flags.
  • test-feature FEATURE returns 0 when FEATURE is enabled, 1 if it is disabled, and 2 if it is not recognized.

Notes

For backwards compatibility each subcommand can also be specified as a long or short option. For example, rather than status is-login you can type status --is-login. The flag forms are deprecated and may be removed in a future release (but not before fish 3.0).

You can only specify one subcommand per invocation even if you use the flag form of the subcommand.