envinfo generates a report of the common details needed when troubleshooting software issues, such as your operating system, binary versions, browsers, installed languages, and more

---

The problem

• It works on my computer
• "command not found"
• what version of "command" are you running?
• what version of "different command" are you running?
• do you have "insert obscure android sdk version"?
• every github issue reporting template ever:

Please mention other relevant information such as the browser version, Node.js version, Operating System and programming language.

This solution

• Gather all of this information in one spot, quickly, and painlessly.

Installation

To use as a CLI tool, install this package globally:

1npm install -g envinfo || yarn global add envinfo

Or, use without installing with npx:

npx envinfo

To use as a library in another project:

1npm install envinfo || yarn add envinfo

CLI Usage

envinfo || npx envinfo

1  System:
2    OS: macOS Mojave 10.14.5
3    CPU: (8) x64 Intel(R) Core(TM) i7-7820HQ CPU @ 2.90GHz
4    Memory: 2.97 GB / 16.00 GB
5    Shell: 5.3 - /bin/zsh
6  Binaries:
7    Node: 8.16.0 - ~/.nvm/versions/node/v8.16.0/bin/node
8    Yarn: 1.15.2 - ~/.yarn/bin/yarn
9    npm: 6.9.0 - ~/.nvm/versions/node/v8.16.0/bin/npm
10    pnpm: 8.7.6 - /usr/local/bin/pnpm
11    bun: 1.0.2 - /usr/local/bin/bun
12    Watchman: 4.9.0 - /usr/local/bin/watchman
13  Managers:
14    Cargo: 1.31.0 - ~/.cargo/bin/cargo
15    CocoaPods: 1.7.3 - /usr/local/bin/pod
16    Composer: 1.8.6 - /usr/local/bin/composer
17    Gradle: 5.5 - /usr/local/bin/gradle
18    Homebrew: 2.1.7 - /usr/local/bin/brew
19    Maven: 3.6.1 - /usr/local/bin/mvn
20    pip2: 19.0.3 - /usr/local/bin/pip2
21    pip3: 19.0.2 - /usr/local/bin/pip3
22    RubyGems: 2.5.2.3 - /usr/bin/gem
23  Utilities:
24    CMake: 3.13.3 - /usr/local/bin/cmake
25    Make: 3.81 - /usr/bin/make
26    GCC: 10.14. - /usr/bin/gcc
27    Git: 2.20.0 - /usr/local/bin/git
28    Mercurial: 4.5.3 - /usr/bin/hg
29    Clang: 1001.0.46.4 - /usr/bin/clang
30    Subversion: 1.10.3 - /usr/bin/svn
31  Servers:
32    Apache: 2.4.34 - /usr/sbin/apachectl
33    Nginx: 1.13.12 - /usr/local/bin/nginx
34  Virtualization:
35    Docker: 18.09.1 - /usr/local/bin/docker
36    Parallels: 13.3.0 - /usr/local/bin/prlctl
37    VirtualBox: 5.2.20 - /usr/local/bin/vboxmanage
38  SDKs:
39    iOS SDK:
40      Platforms: iOS 12.2, macOS 10.14, tvOS 12.2, watchOS 5.2
41    Android SDK:
42      API Levels: 28
43      Build Tools: 28.0.3
44      System Images: android-28 | Google Play Intel x86 Atom
45  IDEs:
46    Android Studio: 3.2 AI-181.5540.7.32.5056338
47    Atom: 1.23.3
48    Emacs: 22.1.1 - /usr/bin/emacs
49    Nano: 2.0.6 - /usr/bin/nano
50    VSCode: 1.36.0 - /usr/local/bin/code
51    Vim: 8.0 - /usr/bin/vim
52    Xcode: 10.2.1/10E1001 - /usr/bin/xcodebuild
53  Languages:
54    Bash: 4.4.23 - /usr/local/bin/bash
55    Elixir: 1.6.2 - /usr/local/bin/elixir
56    Go: 1.11.1 - /usr/local/bin/go
57    Java: 1.8.0_192 - /usr/bin/javac
58    Perl: 5.18.4 - /usr/bin/perl
59    PHP: 7.1.23 - /usr/bin/php
60    Python: 2.7.16 - /usr/local/bin/python
61    Python3: 3.7.2 - /usr/local/bin/python3
62    R: 3.6.0 - /usr/local/bin/R
63    Ruby: 2.3.7 - /usr/bin/ruby
64    Rust: 1.16.0 - /Users/tabrindle/.cargo/bin/rustup
65  Databases:
66    MongoDB: 3.6.4 - /usr/local/bin/mongo
67    MySQL: 10.3.10 (MariaDB) - /usr/local/bin/mysql
68    PostgreSQL: 10.3 - /usr/local/bin/postgres
69    SQLite: 3.24.0 - /usr/bin/sqlite3
70  Browsers:
71    Chrome: 75.0.3770.100
72    Chrome Canary: 77.0.3847.0
73    Firefox: 68.0
74    Firefox Developer Edition: 69.0
75    Firefox Nightly: 69.0a1
76    Safari: 12.1.1
77    Safari Technology Preview: 13.0
78  npmPackages:
79    apollo-client: ^2.3.1 => 2.3.1
80    jest: ^22.2.1 => 22.2.1
81    ...
82    react: ^16.3.2 => 16.3.2
83    react-apollo: ^2.1.4 => 2.1.4
84    run4staged: ^1.1.1 => 1.1.1
85    solidarity: 2.0.5 => 2.0.5
86    styled-components: ^3.1.6 => 3.1.6
87  npmGlobalPackages:
88    create-react-app: 1.5.2
89    create-react-native-app: 1.0.0
90    envinfo: 5.10.0
91    exp: 49.2.2
92    gatsby-cli: 1.1.52
93    npm: 5.6.0
94    react-native-cli: 2.0.1
95    solidarity: 2.1.0
96    typescript: 2.8.1

Programmatic Usage

Envinfo takes a configuration object and returns a Promise that resolves a string (optionally yaml, json or markdown)

1import envinfo from 'envinfo';
2
3envinfo.run(
4    {
5        System: ['OS', 'CPU'],
6        Binaries: ['Node', 'Yarn', 'npm'],
7        Browsers: ['Chrome', 'Firefox', 'Safari'],
8        npmPackages: ['styled-components', 'babel-plugin-styled-components'],
9    },
10    { json: true, showNotFound: true }
11).then(env => console.log(env));

logs:

1{
2    "System": {
3        "OS": "macOS High Sierra 10.13",
4        "CPU": "x64 Intel(R) Core(TM) i7-4870HQ CPU @ 2.50GHz"
5    },
6    "Binaries": {
7        "Node": {
8            "version": "8.11.0",
9            "path": "~/.nvm/versions/node/v8.11.0/bin/node"
10        },
11        "Yarn": {
12            "version": "1.5.1",
13            "path": "~/.yarn/bin/yarn"
14        },
15        "npm": {
16            "version": "5.6.0",
17            "path": "~/.nvm/versions/node/v8.11.0/bin/npm"
18        }
19    },
20    "Browsers": {
21        "Chrome": {
22            "version": "67.0.3396.62"
23        },
24        "Firefox": {
25            "version": "59.0.2"
26        },
27        "Safari": {
28            "version": "11.0"
29        }
30    },
31    "npmPackages": {
32        "styled-components": {
33            "wanted": "^3.2.1",
34            "installed": "3.2.1"
35        },
36        "babel-plugin-styled-components": "Not Found"
37    }
38}

All of envinfo's helpers are also exported for use. You can use envinfo as a whole, or just the parts that you need, like this:

1const envinfo = require('envinfo');
2
3// each helper returns a promise
4const node = await envinfo.helpers.getNodeInfo();
5
6// The promises resolve to an array of values: ["Name", "Version", "Path"]
7// e.g. ["Node", "10.9.0", "/usr/local/bin/node"]
8
9console.log(`Node: ${node[1]} - ${node[2]}`); // "Node: 10.9.0 - ~/.nvm/versions/node/v8.14.0/bin/node"

CLI Options

    --system               Print general system info such as OS, CPU, Memory and Shell
    --browsers             Get version numbers of installed web browsers
    --SDKs                 Get platforms, build tools and SDKs of iOS and Android
    --IDEs                 Get version numbers of installed IDEs
    --languages            Get version numbers of installed languages such as Java, Python, PHP, etc
    --binaries             Get version numbers of node, npm, watchman, etc
    --npmPackages          Get version numbers of locally installed npm packages - glob, string, or comma delimited list
    --npmGlobalPackages    Get version numbers of globally installed npm packages

    --duplicates           Mark duplicate npm packages inside parentheses eg. (2.1.4)
    --fullTree             Traverse entire node_modules dependency tree, not just top level

    --markdown             Print output in markdown format
    --json                 Print output in JSON format
    --console              Print to console (defaults to on for CLI usage, off for programmatic usage)

Integration

envinfo is live in:

• React Native (react-native info)
• Create React App (create-react-app --info)
• Expo Environment Info (npx expo-env-info)
• Webpack (webpack-cli info)
• Solidarity (solidarity report)
• Gatsby (gatsby info)

envinfo is used in the ISSUE_TEMPLATE of:

• styled-components
• Jest
• Apollo Client

Alternatives

• type command -v until you smash your computer
• screenfetch - fetch system and terminal information, and display a pretty ascii logo
• Solidarity - a project based environment checker
• write your own

License

MIT

Contributing

PRs for additional features are welcome! Run npm run lint && npm run format before committing.

This project came out of a PR to the React Native CLI tool - issues are reported frequently without important environment information, like Node/npm versions.

Contributors

Thanks goes to these wonderful people (emoji key):

Trevor Brindle 💬 📝 🐛 💻 📖 💡 🤔 👀 📢 ⚠️	Gant Laborde 📝 🐛 💻 🤔	Anton Fisher 🐛 💻	Ahmad Awais ⚡️ 🐛 💻	Hasan 🐛 💻	Ernesto Ramírez 🐛 💻	Jiawen Geng 🐛 💻 🤔 ⚠️
Zac Anger 💻 🐛	Ville Immonen 🐛 💻	Olmo Maldonado 🐛 💻	Rishabh Chawla 🐛 💻	Carl Taylor 💻

This project follows the all-contributors specification. Contributions of any kind welcome!