Skip to content

Quickly get information about the current directory, system, and node.

License

Notifications You must be signed in to change notification settings

jajaperson/zinfo

Repository files navigation

zinfo Build Status NPM License

Quickly get information about the current directory, system, and node.

Usage

First, install zinfo-logger globally.

# NPM
$ npm install -g zinfo-logger
# Yarn
$ yarn global add zinfo-logger

Then, optionally add default options to your .BASH_PROFILE or .zshrc (you can see available options below).

export ZINFO_DEFAULTS="cwd-path time-24 node-v"

Finally, run the command.

$ zinfo
~/Desktop/GitHub/zinfo
T 13:30:55
⬢ 11.6.0

Configuration

$ zinfo --help
zinfo [args]

Commands:
  zinfo completion  generate bash completion script

Options:
  --include, -i                Which data to print.
                                              [array] [default: $ZINFO_DEFAULTS]
  --exclude, -e                Data to not print         [array] [default: none]
  --ignore-defaults, -I        Ignore "$ZINFO_DEFAULTS"                [boolean]
  --all, -a                    Include all options                     [boolean]
  --underline, -u              Underline data (but not symbols)
                                      [boolean] [default: $ZINFO_UNDERLINE_DATA]
  --nerdfonts, --nf            Use NerdFont symbols
                                           [boolean] [default: $ZINFO_NERDFONTS]
  --icons-secondary, --dimsym  Use a secondary color symbols
                                     [boolean] [default: $ZINFO_ICONS_SECONDARY]
  --options, --ls              List available options.                 [boolean]
  --version, -v                Show version number                     [boolean]
  --help                       Show help                               [boolean]

Options

Options can be specified by the --include option (see above), or through the $ZINFO_DEFAULTS environment variable.

cwd-path

The current directory, in home-relative format.

cwd-path-absolute

The current directory's absolute path.

git-overview

Information about the current directory's git, if the current directory is a git repository. * means the repository is dirty, and an upwards arrow () is displayed if there are commits to push, a downwards arrow () is displayed if there are commits on origin to pull.

git-branch

The current git branch.

git-last-commit

The last commit in the local repository.

git-ahead

The number of commits ahead of origin the local repository is.

git-behind

The number of commits behind origin the local repository is.

platform

The platform being used.

user

The current user.

time

The current time.

time-24

The current time, in 24-hour format.

date

The current date.

date-time

The current date and time.

date-time-24

The current date and time, in 24-hour format.

node-v

The current node version.

uptime

How long the system has been up.

About

Quickly get information about the current directory, system, and node.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •