INXI(1) | inxi manual | INXI(1) |
inxi - Command line system information script for console and IRC
inxi
inxi [-AbBCdDfFGhiIlmMnNopPrRsSuUVwzZ]
inxi [-c NUMBER] [-t [c|m|cm|mc] [NUMBER]] [-v NUMBER] [-W LOCATION] [--weather-unit {m|i|mi|im}] [-y WIDTH]
inxi [--recommends] [--slots] [--usb]
inxi [-x|-xx|-xxx|-a|--admin] -OPTION(s)
All options have long form variants - see below for these and more advanced options.
inxi is a command line system information script built for console and IRC. It is also used a debugging tool for forum technical support to quickly ascertain users' system configurations and hardware. inxi shows system hardware, CPU, drivers, Xorg, Desktop, Kernel, gcc version(s), Processes, RAM usage, and a wide variety of other useful information.
inxi output varies depending on whether it is being used on CLI or IRC, with some default filters and color options applied only for IRC use. Script colors can be turned off if desired with -c 0, or changed using the -c color options listed in the STANDARD OPTIONS section below.
In order to maintain basic privacy and security, inxi used on IRC automatically filters out your network device MAC address, WAN and LAN IP, your /home username directory in partitions, and a few other items.
Because inxi is often used on forums for support, you can also trigger this filtering with the -z option (-Fz, for example). To override the IRC filter, you can use the -Z option. This can be useful in debugging network connection issues online in a private chat, for example.
Options can be combined if they do not conflict. You can either group the letters together or separate them.
Letters with numbers can have no gap or a gap at your discretion, except when using -t.
For example: inxi -AG or inxi -A -G or inxi -c10
Note that all the short form options have long form equivalents, which are listed below. However, usually the short form is used in examples in order to keep things simple.
Note that for charge, the output shows the current charge, as well as its value as a percentage of the available capacity, which can be less than the original design capacity. In the following example, the actual current available capacity of the battery is 22.2 Wh.
charge: 20.1 Wh 95.4%
The condition item shows the remaining available capacity / original design capacity, and then this figure as a percentage of original capacity available in the battery.
condition: 22.2/36.4 Wh (61%)
With -x shows attached Device-x information (mouse, keyboard, etc.) if they are battery powered.
These color selectors run a color selector option prior to inxi starting which lets you set the config file value for the selection.
NOTE: All configuration file set color values are removed when output is piped or redirected. You must use the explicit runtime -c <color number> option if you want color codes to be present in the piped/redirected output.
Color selectors for each type display (NOTE: IRC and global only show safe color set):
Setting a specific color type removes the global color selection.
For certain CPUs (some ARM, and AMD Zen family) shows CPU die count.
The details for each CPU include a technical description e.g. type: MT MCP
* MT - Multi/Hyper Threaded CPU, more than 1 thread per core (previously HT).
* MCM - Multi Chip Model (more than 1 die per CPU).
* MCP - Multi Core Processor (more than 1 core per CPU).
* SMP - Symmetric Multi Processing (more than 1 physical CPU).
* UP - Uni (single core) Processor.
Also shows per disk information: Disk ID, type (if present), vendor (if detected), model, and size. See Extra Data Options for more features.
Display: x11 server: Xorg 1.15.1
If protocol is not detected, shows:
Display: server: Xorg 1.15.1
Also shows screen resolution(s), OpenGL renderer, OpenGL core profile version/OpenGL version.
Compositor information will show if detected using -xx option.
Note: if -m is used or triggered, the memory item will show in the main Memory: report of -m, not in Info:.
Rasberry Pi only: uses vcgencmd get_mem gpu to get gpu RAM amount, if user is in video group and vcgencmd is installed. Uses this result to increase the Memory: amount and used: amounts.
Note: -m uses dmidecode, which must be run as root (or start inxi with sudo), unless you figure out how to set up sudo to permit dmidecode to read /dev/mem as user. speed and bus width will not show if No Module Installed is found in size.
Note: If -m is triggered RAM total/used report will appear in this section, not in -I or -tm items.
Because dmidecode data is extremely unreliable, inxi will try to make best guesses. If you see (check) after the capacity number, you should check it with the specifications. (est) is slightly more reliable, but you should still check the real specifications before buying RAM. Unfortunately there is nothing inxi can do to get truly reliable data about the system RAM; maybe one day the kernel devs will put this data into /sys, and make it real data, taken from the actual system, not dmi data. For most people, the data will be right, but a significant percentage of users will have either a wrong max module size, if present, or max capacity.
Device information requires either /sys or dmidecode. Note that 'other-vm?' is a type that means it's usually a VM, but inxi failed to detect which type, or positively confirm which VM it is. Primary VM identification is via systemd-detect-virt but fallback tests that should also support some BSDs are used. Less commonly used or harder to detect VMs may not be correctly detected. If you get an incorrect output, post an issue and we'll get it fixed if possible.
Due to unreliable vendor data, device type will show: desktop, laptop, notebook, server, blade, plus some obscure stuff that inxi is unlikely to ever run on.
<username> ALL = NOPASSWD: /usr/bin/file (sample)
Does not show components (partitions that create the md-raid array) of md-raid arrays.
APK (Alpine Linux + derived versions)
APT (Debian, Ubuntu + derived versions, as well as RPM based APT distros like PCLinuxOS or Alt-Linux)
CARDS (NuTyX + derived versions)
EOPKG (Solus)
PACMAN (Arch Linux, KaOS + derived versions)
PACMAN-G2 (Frugalware + derived versions)
PISI (Pardus + derived versions)
PORTAGE (Gentoo, Sabayon + derived versions)
PORTS (OpenBSD, FreeBSD, NetBSD + derived OS types)
SLACKPKG (Slackware + derived versions)
TCE (TinyCore)
URPMQ (Mandriva, Mageia + derived versions)
XBPS (Void)
YUM/ZYPP (Fedora, Red Hat, Suse + derived versions)
More will be added as distro data is collected. If yours is missing please show us how to get this information and we'll try to add it.
md-raid: If device is resyncing, also shows resync progress line.
Note: Only md-raid and ZFS are currently supported. Other software RAID types could be added, but only if users supply all data required, and if the software RAID actually can be made to give the required output.
If hardware RAID is detected, shows basic information. Due to complexity of adding hardware RAID device disk / RAID reports, those will only be added if there is demand, and reasonable reporting tools.
Make sure that there is no space between letters and numbers (e.g. write as -t cm10).
Hubs and Devices are listed in order of BusID.
BusID is generally in this format: BusID-port[.port][.port]:DeviceID
Device ID is a number created by the kernel, and has no necessary ordering or sequence connection, but can be used to match this output to lsusb values, which generally shows BusID / DeviceID (except for tree view, which shows ports).
Examples: Device-3: 4-3.2.1:2 or Hub: 4-0:1
The rev: 2.0 item refers to the USB revision number, like 1.0 or 3.1.
If inxi -h has no listing for -U then it's disabled.
Auto-update script. Note: if you installed as root, you must be root to update, otherwise user is fine. Also installs / updates this man page to: /usr/local/share/man/man1 (if /usr/local/share/man/ exists AND there is no inxi man page in /usr/share/man/man1, otherwise it goes to /usr/share/man/man1). This requires that you be root to write to that directory. See --man or --no-man to force or disable man install.
Supported levels: 0-8 Examples : inxi -v 4 or inxi -v4
Use only ASCII letters in city/state/country names.
Examples: -W 95623,us OR -W Boston,MA OR -W 45.5234,-122.6762 OR -W new+york,ny OR -W bodo,norway.
More data sources will be added as time permits, so try each one and see which you prefer. If you get unsupported source message, it means that number has not been implemented.
These options can be triggered by one or more -x. Alternatively, the -v options trigger them in the following way: -v 3 adds -x; -v 6 adds -xx; -v 7 adds -xxx
These extra data triggers can be useful for getting more in-depth data on various options. They can be added to any long form option list, e.g.: -bxx or -Sxxx
There are 3 extra data levels:
-x, -xx, -xxx
OR
--extra 1, --extra 2, --extra 3
The following details show which lines / items display extra information for each extra data level.
- Adds version/port(s)/driver version (if available) for each Audio device.
- Adds PCI Bus ID/USB ID number of each Audio device.
- Adds attached battery powered peripherals (Device-[number]:) if detected (keyboard, mouse, etc.).
- Adds CPU Flags (short list). Use -f to see full flag/feature list.
- Adds CPU microarchitecture + revision (e.g. Sandy Bridge, K8, ARMv8, P6, etc.). Only shows data if detected. Newer microarchitectures will have to be added as they appear, and require the CPU family ID and model ID.
Examples: arch: Sandy Bridge rev: 2, arch: K8 rev.F+ rev: 2
<username> ALL = NOPASSWD: /usr/sbin/hddtemp (sample)
- Adds direct rendering status.
- Adds (for single GPU, nvidia driver) screen number that GPU is running on.
- Adds PCI Bus ID/USB ID number of each Graphics card.
Note that there is no way I am aware of to filter out the deprecated IP v6 scope site/global temporary addresses from the output of ifconfig. The ip tool shows that clearly.
ip-v6-temporary - (ip tool only), scope global temporary. Scope global temporary deprecated is not shown
ip-v6-global - scope global (ifconfig will show this for all types, global, global temporary, and global temporary deprecated, ip shows it only for global)
ip-v6-link - scope link (ip/ifconfig) - default for -i.
ip-v6-site - scope site (ip/ifconfig). This has been deprecated in IPv6, but still exists. ifconfig may show multiple site values, as with global temporary, and global temporary deprecated.
ip-v6-unknown - unknown scope
- Adds default system gcc. With -xx, also show other installed gcc versions.
- Adds current runlevel (not available with all init systems).
- If in shell (i.e. not in IRC client), adds shell version number, if available.
- Adds device type in the Device line.
- Adds version/port(s)/driver version (if available) for each Network card;
- Adds PCI Bus ID/USB ID number of each Network card.
- Hardware RAID: Adds driver version, bus ID.
- Adds to Distro: base: if detected. System base will only be seen on a subset of distributions. The distro must be both derived from a parent distro (e.g. Mint from Ubuntu), and explicitly added to the supported distributions for this feature. Due to the complexity of distribution identification, these will only be added as relatively solid methods are found for each distribution system base detection.
- Adds wind speed and direction.
- Adds disk speed (if available). This is the theoretical top speed of the device as reported. This speed may be restricted by system board limits, eg. a SATA 3 drive on a SATA 2 board may report SATA 2 speeds, but this is not completely consistent, sometimes a SATA 3 device on a SATA 2 board reports its design speed.
NVMe drives: adds lanes, and (per direction) speed is calculated with lane speed * lanes * PCIe overhead. PCIe 1 and 2 have data rates of GT/s * .8 = Gb/s (10 bits required to transfer 8 bits of data). PCIe 3 and greater transfer data at a rate of GT/s * 128/130 * lanes = Gb/s (130 bits required to transfer 128 bits of data).
For a PCIe 3 NVMe drive, with speed of 8 GT/s and 4 lanes (8GT/s * 128/130 * 4 = 31.6 Gb/s):
speed: 31.6 Gb/s lanes: 4
- Adds compositor, if found (experimental).
- For free drivers, adds OpenGL compatibility version number if available. For nonfree drivers, the core version and compatibility versions are usually the same. Example:
v: 3.3 Mesa 11.2.0 compat-v: 3.0
- If available, shows alternate: Xorg drivers. This means a driver on the default list of drivers Xorg automatically checks for the card, but which is not installed. For example, if you have nouveau driver, nvidia would show as alternate if it was not installed. Note that alternate: does NOT mean you should have it, it's just one of the drivers Xorg checks to see if is present and loaded when checking the card. This can let you know there are other driver options. Note that if you have explicitly set the driver in xorg.conf, Xorg will not create this automatic check driver list.
- Adds other detected installed gcc versions (if present).
- Adds system default runlevel, if detected. Supports Systemd/Upstart/SysVinit type defaults.
- Adds parent program (or tty) that started shell, if not IRC client.
- Adds memory device Part Number (part-no:). Useful for ordering new or replacement memory sticks etc. Part numbers are unique, particularly if you use the word memory in the search as well. With -xxx, also shows serial number.
- Adds single/double bank memory, if data is found. Note, this may not be 100% right all of the time since it depends on the order that data is found in dmidecode output for type 6 and type 17.
- Hardware RAID: Adds Chip vendor:product ID.
- Adds, if run in X, window manager type (wm), if available. Not all window managers are supported. Some desktops support using more than one window manager, so this can be useful to see what window manager is actually running. If none found, shows nothing. Uses a less accurate fallback tool wmctrl if ps tests fail to find data.
- Adds desktop toolkit (tk), if available (Xfce/KDE/Trinity).
- Adds cloud cover, rain, snow, or precipitation (amount in previous hour to observation time), if available.
- Adds attached device rechargeable: [yes|no] information.
- Adds disk partition scheme (in most cases), e.g. scheme: GPT. Currently not able to detect all schemes, but handles the most common, e.g. GPT or MBR.
- Adds disk rotation speed (in some but not all cases), e.g. rotation: 7200 rpm. Only appears if detected (SSD drives do not have rotation speeds, for example). If none found, nothing shows. Not all disks report this speed, so even if they are spinnning, no data will show.
- For running in: adds (SSH) to parent, if present. SSH detection uses the who am i test.
- Adds device Type Detail, e.g. detail: DDR3 (Synchronous).
- Adds, if present, memory module voltage. Only some systems will have this data available.
- Adds device serial number.
- zfs-raid: Adds portion allocated (used) by RAID array/device.
- Hardware RAID: Adds rev, ports, and (if available and/or relevant) vendor: item, which shows specific vendor [product] information.
- Adds (if present), window manager (wm) version number.
- Adds (if present), display manager (dm) version number.
- Adds interfaces: for non hub devices.
- Adds, if available, USB speed in Mbits/s or Gbits/s.
These options are triggered with --admin or -a. Admin options are advanced output options, and are more technical, and mostly of interest to system administrators or other machine admins. The --admin option only has to be used once, and will trigger the following features.
- Adds CPU microcode. Format is hexadecimal.
- Adds CPU Vulnerabilities (bugs) as known by your current kernel. Lists by Type: ... (status|mitigation): .... for systems that support this feature (Linux kernel 4.14 or newer, or patched older kernels).
raw size: 60.00 GiB.
- Adds percent of raw size available to size: item, e.g.
size: 58.81 GiB (98.01%).
Note that used: 16.44 GiB (34.3%) percent refers to the available size, not the raw size.
- Adds partition filesystem block size if found (requires root and blockdev).
- For swap, adds swappiness and vfs cache pressure, and a message to indicate if it is the default value or not (Linux only, and only if available). If not, shows default value as well, e.g.
swappiness: 60 (default) cache pressure: 90 (default 100).
Note that in some cases, --display will cause inxi to hang endlessly when running the option in console with Intel graphics. The situation regarding other free drivers such as nouveau/ATI is currently unknown. It may be that this is a bug with the Intel graphics driver - more information is required.
You can test this easily by running the following command out of X/display server: glxinfo -display :0
If it hangs, --display will not work.
SHOW_HOST='false'
INDENT_MIN=85
SHOW_HOST='false'
dev-base - /dev partition identifier, like /dev/sda1. Note that it's an alphabetic sort, so sda12 is before sda2.
fs - Partition filesystem. Note that sorts will be somewhat random if all filesystems are the same.
id - Mount point of partition (default).
label - Label of partition. If partitions have no labels, sort will be random.
percent-used - Percentage of partition size used.
size - KiB size of partition.
uuid - UUID of the partition.
used - KiB used of partition.
inxi -Cxxx --sleep 0.15
Overrides default internal value and user configuration value:
CPU_SLEEP=0.25
The sign you need to use this is extra numbers before the key/value pairs of the output of your program. These are IRC, not TTY, color codes. Please post a github issue if you find you need to use --tty (including the full -Ixxx line) so we can figure out how to add your program to the list of whitelisted programs.
You can see what inxi believed started it in the -Ixxx line, Shell: or Client: item. Please let us know what that result was so we can add it to the parent start program whitelist.
The IP address from the URL must be the last item on the last (non-empty) line of the page content source code.
Same as configuration value (example):
WAN_IP_URL='https://mysite.com/ip.php'
* tree traversal data file(s) read from /proc and /sys, and other system data.
* xorg conf and log data, xrandr, xprop, xdpyinfo, glxinfo etc.
* data from dev, disks, partitions, etc.
inxi --ftp ftp.yourserver.com/incoming --debug 21
Only used the following in conjunction with --debug 2[012], and only use if you experienced a failure or hang, or were instructed to do so.
BitchX, Gaim/Pidgin, ircII, Irssi, Konversation, Kopete, KSirc, KVIrc, Weechat, and Xchat. Plus any others that are capable of displaying either built-in or external script output.
To trigger inxi output in your IRC client, pick the appropriate method from the list below:
To run inxi in Konversation as a native script if your distribution or inxi package hasn't already done this for you, create this symbolic link:
KDE 4: ln -s /usr/local/bin/inxi /usr/share/kde4/apps/konversation/scripts/inxi
KDE 5: ln -s /usr/local/bin/inxi /usr/share/konversation/scripts/inxi
If inxi is somewhere else, change the path /usr/local/bin to wherever it is located.
If you are using KDE/QT 5, then you may also need to add the following to get the Konversation /inxi command to work:
ln -s /usr/share/konversation /usr/share/apps/
Then you can start inxi directly, like this:
/inxi [options]
OLD: /shell -o inxi [options]
Newer (2014 and later) WeeChats work pretty much the same now as other console IRC clients, with /exec -o inxi [options]. Newer WeeChats have dropped the -curses part of their program name, i.e.: weechat instead of weechat-curses.
inxi will read its configuration/initialization files in the following order:
/etc/inxi.conf contains the default configurations. These can be overridden by user configurations found in one of the following locations (inxi will store its config file using the following precedence: if $XDG_CONFIG_HOME is not empty, it will go there, else if $HOME/.conf/inxi.conf exists, it will go there, and as a last default, the legacy location is used), i.e.:
$XDG_CONFIG_HOME/inxi.conf > $HOME/.conf/inxi.conf > $HOME/.inxi/inxi.conf
See the documentation page for more complete information on how to set these up, and for a complete list of options:
https://smxi.org/docs/inxi-configuration.htm
COLS_MAX_CONSOLE The max display column width on terminal.
COLS_MAX_IRC The max display column width on IRC clients.
COLS_MAX_NO_DISPLAY The max display column width in console, out of GUI desktop.
CPU_SLEEP Decimal value 0 or more. Default is usually around 0.35 seconds. Time that inxi will 'sleep' before getting CPU speed data, so that it reflects actual system state.
DOWNLOADER Sets default inxi downloader: curl, fetch, ftp, perl, wget. See --recommends output for more information on downloaders and Perl downloaders.
FILTER_STRING Default <filter>. Any string you prefer to see instead for filtered values.
INDENT_MIN The point where the line starter wrapping to its own line happens. Overrides default. See --indent-min. If 80 or less, wrap will never happen.
LIMIT Overrides default of 10 IP addresses per IF. This is only of interest to sys admins running servers with many IP addresses.
PARTITION_SORT Overrides default partition output sort. See --partition-sort for options.
PS_COUNT The default number of items showing per -t type, m or c. Default is 5.
SENSORS_CPU_NO In cases of ambiguous temp1/temp2 (inxi can't figure out which is the CPU), forces sensors to use either value 1 or 2 as CPU temperature. See the above configuration page on smxi.org for full info.
SEP2_CONSOLE Replaces default key / value separator of ':'.
USB_SYS Forces all USB data to use /sys instead of lsusb.
WAN_IP_URL Forces -i to use supplied URL, and to not use dig (dig is generally much faster). URL must begin with http or ftp. Note that if you use this, the downloader set tests will run each time you start inxi whether a downloader feature is going to be used or not.
The IP address from the URL must be the last item on the last (non-empty) line of the URL's page content source code.
Same as --wan-ip-url [URL]
WEATHER_SOURCE Values: [0-9]. Same as --weather-source. Values 4-9 are not currently supported, but this can change at any time.
WEATHER_UNIT Values: [c|f|cf|fc]. Same as --weather-unit.
NOTE: All default and configuration file set color values are removed when output is piped or redirected. You must use the explicit -c <color number> option if you want colors to be present in the piped/redirected output (creating a PDF for example).
CONSOLE_COLOR_SCHEME The color scheme for console output (not in X/Wayland).
GLOBAL_COLOR_SCHEME Overrides all other color schemes.
IRC_COLOR_SCHEME Desktop X/Wayland IRC CLI color scheme.
IRC_CONS_COLOR_SCHEME Out of X/Wayland, IRC CLI color scheme.
IRC_X_TERM_COLOR_SCHEME In X/Wayland IRC client terminal color scheme.
VIRT_TERM_COLOR_SCHEME Color scheme for virtual terminal output (in X/Wayland).
Please report bugs using the following resources.
You may be asked to run the inxi debugger tool (see --debug 21/22), which will upload a data dump of system files for use in debugging inxi. These data dumps are very important since they provide us with all the real system data inxi uses to parse out its report.
https://github.com/smxi/inxi
https://smxi.org/docs/inxi.htm
inxi is a fork of locsmif's very clever infobash script.
Original infobash author and copyright holder: Copyright (C) 2005-2007 Michiel de Boer aka locsmif
inxi version: Copyright (C) 2008-18 Harald Hope
This man page was originally created by Gordon Spencer (aka aus9) and is maintained by Harald Hope (aka h2 or TechAdmin).
Initial CPU logic, konversation version logic, occasional maintenance fixes, and the initial xiin.py tool for /sys parsing (obsolete, but still very much appreciated for all the valuable debugger data it helped generate): Scott Rogers
Further fixes (listed as known):
Horst Tritremmel <hjt at sidux.com>
Steven Barrett (aka: damentz) - USB audio patch; swap percent used patch.
Jarett.Stevens - dmidecode -M patch for older systems with no /sys.
The nice people at irc.oftc.net channels #linux-smokers-club and #smxi, who all really have to be considered to be co-developers because of their non-stop enthusiasm and willingness to provide real-time testing and debugging of inxi development.
Siduction forum members, who have helped get some features working by providing a large number of datasets that have revealed possible variations, particularly for the RAM -m option.
AntiX users and admins, who have helped greatly with testing and debugging, particularly for the 3.0.0 release.
ArcherSeven (Max), Brett Bohnenkamper (aka KittyKatt), and Iotaka, who always manage to find the weirdest or most extreme hardware and setups that help make inxi much more robust.
For the vastly underrated skill of output error/glitch catching, Pete Haddow. His patience and focus in going through inxi repeatedly to find errors and inconsistencies is much appreciated.
All the inxi package maintainers, distro support people, forum moderators, and in particular, sys admins with their particular issues, which almost always help make inxi better, and any others who contribute ideas, suggestions, and patches.
Without a wide range of diverse Linux kernel-based Free Desktop systems to test on, we could never have gotten inxi to be as reliable and solid as it's turning out to be.
And of course, a big thanks to locsmif, who figured out a lot of the core methods, logic, and tricks originally used in inxi Gawk/Bash.
2019-02-07 | inxi |