node_modules/envinfo/README.md

   1 <p align="center">
   2   <img src="https://raw.githubusercontent.com/tabrindle/envinfo/master/logo.png" align="center"  width="700px"/>
   3   <h3 align="center">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</h3>
   4   <hr/>
   5 </p>
   6
   7 [![CircleCI](https://circleci.com/gh/tabrindle/envinfo/tree/master.svg?style=svg)](https://circleci.com/gh/tabrindle/envinfo/tree/master) [![Build Status](https://travis-ci.org/tabrindle/envinfo.svg?branch=master)](https://travis-ci.org/tabrindle/envinfo) [![npm version](https://badge.fury.io/js/envinfo.svg)](https://badge.fury.io/js/envinfo) [![npm downloads per month](https://img.shields.io/npm/dm/envinfo.svg?maxAge=86400)](https://www.npmjs.com/package/envinfo) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
   8 [![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors)
   9
  10 ## The problem
  11
  12 -   It works on my computer
  13 -   "command not found"
  14 -   what version of "command" are you running?
  15 -   what version of "different command" are you running?
  16 -   do you have "insert obscure android sdk version"?
  17 -   every github issue reporting template ever:
  18
  19 **Please mention other relevant information such as the browser version, Node.js version, Operating System and programming language.**
  20
  21 ## This solution
  22
  23 -   Gather all of this information in one spot, quickly, and painlessly.
  24
  25 ## Installation
  26
  27 To use as a CLI tool, install this package globally:
  28
  29 ```sh
  30 npm install -g envinfo || yarn global add envinfo
  31 ```
  32
  33 Or, use without installing with npx:
  34
  35 `npx envinfo`
  36
  37 To use as a library in another project:
  38
  39 ```sh
  40 npm install envinfo || yarn add envinfo
  41 ```
  42
  43 ## CLI Usage
  44
  45 `envinfo` || `npx envinfo`
  46
  47 ```bash
  48   System:
  49     OS: macOS Mojave 10.14.5
  50     CPU: (8) x64 Intel(R) Core(TM) i7-7820HQ CPU @ 2.90GHz
  51     Memory: 2.97 GB / 16.00 GB
  52     Shell: 5.3 - /bin/zsh
  53   Binaries:
  54     Node: 8.16.0 - ~/.nvm/versions/node/v8.16.0/bin/node
  55     Yarn: 1.15.2 - ~/.yarn/bin/yarn
  56     npm: 6.9.0 - ~/.nvm/versions/node/v8.16.0/bin/npm
  57     Watchman: 4.9.0 - /usr/local/bin/watchman
  58   Managers:
  59     Cargo: 1.31.0 - ~/.cargo/bin/cargo
  60     CocoaPods: 1.7.3 - /usr/local/bin/pod
  61     Composer: 1.8.6 - /usr/local/bin/composer
  62     Gradle: 5.5 - /usr/local/bin/gradle
  63     Homebrew: 2.1.7 - /usr/local/bin/brew
  64     Maven: 3.6.1 - /usr/local/bin/mvn
  65     pip2: 19.0.3 - /usr/local/bin/pip2
  66     pip3: 19.0.2 - /usr/local/bin/pip3
  67     RubyGems: 2.5.2.3 - /usr/bin/gem
  68   Utilities:
  69     CMake: 3.13.3 - /usr/local/bin/cmake
  70     Make: 3.81 - /usr/bin/make
  71     GCC: 10.14. - /usr/bin/gcc
  72     Git: 2.20.0 - /usr/local/bin/git
  73     Mercurial: 4.5.3 - /usr/bin/hg
  74     Clang: 1001.0.46.4 - /usr/bin/clang
  75     Subversion: 1.10.3 - /usr/bin/svn
  76   Servers:
  77     Apache: 2.4.34 - /usr/sbin/apachectl
  78     Nginx: 1.13.12 - /usr/local/bin/nginx
  79   Virtualization:
  80     Docker: 18.09.1 - /usr/local/bin/docker
  81     Parallels: 13.3.0 - /usr/local/bin/prlctl
  82     VirtualBox: 5.2.20 - /usr/local/bin/vboxmanage
  83   SDKs:
  84     iOS SDK:
  85       Platforms: iOS 12.2, macOS 10.14, tvOS 12.2, watchOS 5.2
  86     Android SDK:
  87       API Levels: 28
  88       Build Tools: 28.0.3
  89       System Images: android-28 | Google Play Intel x86 Atom
  90   IDEs:
  91     Android Studio: 3.2 AI-181.5540.7.32.5056338
  92     Atom: 1.23.3
  93     Emacs: 22.1.1 - /usr/bin/emacs
  94     Nano: 2.0.6 - /usr/bin/nano
  95     VSCode: 1.36.0 - /usr/local/bin/code
  96     Vim: 8.0 - /usr/bin/vim
  97     Xcode: 10.2.1/10E1001 - /usr/bin/xcodebuild
  98   Languages:
  99     Bash: 4.4.23 - /usr/local/bin/bash
 100     Elixir: 1.6.2 - /usr/local/bin/elixir
 101     Go: 1.11.1 - /usr/local/bin/go
 102     Java: 1.8.0_192 - /usr/bin/javac
 103     Perl: 5.18.4 - /usr/bin/perl
 104     PHP: 7.1.23 - /usr/bin/php
 105     Python: 2.7.16 - /usr/local/bin/python
 106     Python3: 3.7.2 - /usr/local/bin/python3
 107     R: 3.6.0 - /usr/local/bin/R
 108     Ruby: 2.3.7 - /usr/bin/ruby
 109     Rust: 1.16.0 - /Users/tabrindle/.cargo/bin/rustup
 110   Databases:
 111     MongoDB: 3.6.4 - /usr/local/bin/mongo
 112     MySQL: 10.3.10 (MariaDB) - /usr/local/bin/mysql
 113     PostgreSQL: 10.3 - /usr/local/bin/postgres
 114     SQLite: 3.24.0 - /usr/bin/sqlite3
 115   Browsers:
 116     Chrome: 75.0.3770.100
 117     Chrome Canary: 77.0.3847.0
 118     Firefox: 68.0
 119     Firefox Developer Edition: 69.0
 120     Firefox Nightly: 69.0a1
 121     Safari: 12.1.1
 122     Safari Technology Preview: 13.0
 123   npmPackages:
 124     apollo-client: ^2.3.1 => 2.3.1
 125     jest: ^22.2.1 => 22.2.1
 126     ...
 127     react: ^16.3.2 => 16.3.2
 128     react-apollo: ^2.1.4 => 2.1.4
 129     run4staged: ^1.1.1 => 1.1.1
 130     solidarity: 2.0.5 => 2.0.5
 131     styled-components: ^3.1.6 => 3.1.6
 132   npmGlobalPackages:
 133     create-react-app: 1.5.2
 134     create-react-native-app: 1.0.0
 135     envinfo: 5.10.0
 136     exp: 49.2.2
 137     gatsby-cli: 1.1.52
 138     npm: 5.6.0
 139     react-native-cli: 2.0.1
 140     solidarity: 2.1.0
 141     typescript: 2.8.1
 142 ```
 143
 144 ## Programmatic Usage
 145
 146 Envinfo takes a configuration object and returns a Promise that resolves a string (optionally yaml, json or markdown)
 147
 148 ```javascript
 149 import envinfo from 'envinfo';
 150
 151 envinfo.run(
 152     {
 153         System: ['OS', 'CPU'],
 154         Binaries: ['Node', 'Yarn', 'npm'],
 155         Browsers: ['Chrome', 'Firefox', 'Safari'],
 156         npmPackages: ['styled-components', 'babel-plugin-styled-components'],
 157     },
 158     { json: true, showNotFound: true }
 159 ).then(env => console.log(env));
 160 ```
 161
 162 logs:
 163
 164 ```json
 165 {
 166     "System": {
 167         "OS": "macOS High Sierra 10.13",
 168         "CPU": "x64 Intel(R) Core(TM) i7-4870HQ CPU @ 2.50GHz"
 169     },
 170     "Binaries": {
 171         "Node": {
 172             "version": "8.11.0",
 173             "path": "~/.nvm/versions/node/v8.11.0/bin/node"
 174         },
 175         "Yarn": {
 176             "version": "1.5.1",
 177             "path": "~/.yarn/bin/yarn"
 178         },
 179         "npm": {
 180             "version": "5.6.0",
 181             "path": "~/.nvm/versions/node/v8.11.0/bin/npm"
 182         }
 183     },
 184     "Browsers": {
 185         "Chrome": {
 186             "version": "67.0.3396.62"
 187         },
 188         "Firefox": {
 189             "version": "59.0.2"
 190         },
 191         "Safari": {
 192             "version": "11.0"
 193         }
 194     },
 195     "npmPackages": {
 196         "styled-components": {
 197             "wanted": "^3.2.1",
 198             "installed": "3.2.1"
 199         },
 200         "babel-plugin-styled-components": "Not Found"
 201     }
 202 }
 203 ```
 204
 205 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:
 206
 207 ```javascript
 208 const envinfo = require('envinfo');
 209
 210 // each helper returns a promise
 211 const node = await envinfo.helpers.getNodeInfo();
 212
 213 // The promises resolve to an array of values: ["Name", "Version", "Path"]
 214 // e.g. ["Node", "10.9.0", "/usr/local/bin/node"]
 215
 216 console.log(`Node: ${node[1]} - ${node[2]}`); // "Node: 10.9.0 - ~/.nvm/versions/node/v8.14.0/bin/node"
 217 ```
 218
 219 ## CLI Options
 220
 221 ```
 222     --system               Print general system info such as OS, CPU, Memory and Shell
 223     --browsers             Get version numbers of installed web browsers
 224     --SDKs                 Get platforms, build tools and SDKs of iOS and Android
 225     --IDEs                 Get version numbers of installed IDEs
 226     --languages            Get version numbers of installed languages such as Java, Python, PHP, etc
 227     --binaries             Get version numbers of node, npm, watchman, etc
 228     --npmPackages          Get version numbers of locally installed npm packages - glob, string, or comma delimited list
 229     --npmGlobalPackages    Get version numbers of globally installed npm packages
 230
 231     --duplicates           Mark duplicate npm packages inside parentheses eg. (2.1.4)
 232     --fullTree             Traverse entire node_modules dependency tree, not just top level
 233
 234     --markdown             Print output in markdown format
 235     --json                 Print output in JSON format
 236     --console              Print to console (defaults to on for CLI usage, off for programmatic usage)
 237 ```
 238
 239 ## Integration
 240
 241 envinfo is live in:
 242
 243 -   [React Native](https://github.com/facebook/react-native) (`react-native info`)
 244 -   [Create React App](https://github.com/facebook/create-react-app) (`create-react-app --info`)
 245 -   [Expo CLI](https://github.com/expo/expo-cli) (`expo diagnostics`)
 246 -   [Webpack](https://github.com/webpack/webpack-cli) (`webpack-cli info`)
 247 -   [Solidarity](https://github.com/infinitered/solidarity) (`solidarity report`)
 248 -   [Gatsby](https://github.com/gatsbyjs/gatsby) (`gatsby info`)
 249
 250 envinfo is used in the ISSUE_TEMPLATE of:
 251
 252 -   [styled-components](https://github.com/styled-components/styled-components)
 253 -   [Jest](https://github.com/facebook/jest)
 254 -   [Apollo Client](https://github.com/apollographql/apollo-client)
 255
 256 ## Alternatives
 257
 258 -   type `command -v` until you smash your computer
 259 -   [specs](https://github.com/mcandre/specs) - an excellent ruby gem that runs `command -v` for you on :all-the-things: Great for raw info.
 260 -   [screenfetch](https://github.com/KittyKatt/screenFetch) - fetch system and terminal information, and display a pretty ascii logo
 261 -   [Solidarity](https://github.com/infinitered/solidarity) - a project based environment checker
 262 -   write your own
 263
 264 ## License
 265
 266 MIT
 267
 268 ## Contributing
 269
 270 PRs for additional features are welcome! Run `npm run lint && npm run format` before committing.
 271
 272 This project came out of a [PR](https://github.com/facebook/react-native/pull/14428) to the React Native CLI tool - issues are reported frequently without important environment information, like Node/npm versions.
 273
 274 ## Contributors
 275
 276 Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
 277
 278 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 279 <!-- prettier-ignore -->
 280 | [<img src="https://avatars1.githubusercontent.com/u/2925048?v=4" width="100px;"/><br /><sub><b>Trevor Brindle</b></sub>](http://trevorbrindle.com)<br />[💬](#question-tabrindle "Answering Questions") [📝](#blog-tabrindle "Blogposts") [🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Atabrindle "Bug reports") [💻](https://github.com/tabrindle/envinfo/commits?author=tabrindle "Code") [📖](https://github.com/tabrindle/envinfo/commits?author=tabrindle "Documentation") [💡](#example-tabrindle "Examples") [🤔](#ideas-tabrindle "Ideas, Planning, & Feedback") [👀](#review-tabrindle "Reviewed Pull Requests") [📢](#talk-tabrindle "Talks") [⚠️](https://github.com/tabrindle/envinfo/commits?author=tabrindle "Tests") | [<img src="https://avatars0.githubusercontent.com/u/997157?v=4" width="100px;"/><br /><sub><b>Gant Laborde</b></sub>](http://gantlaborde.com/)<br />[📝](#blog-GantMan "Blogposts") [🐛](https://github.com/tabrindle/envinfo/issues?q=author%3AGantMan "Bug reports") [💻](https://github.com/tabrindle/envinfo/commits?author=GantMan "Code") [🤔](#ideas-GantMan "Ideas, Planning, & Feedback") | [<img src="https://avatars1.githubusercontent.com/u/599352?v=4" width="100px;"/><br /><sub><b>Anton Fisher</b></sub>](http://antonfisher.com)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Aantonfisher "Bug reports") [💻](https://github.com/tabrindle/envinfo/commits?author=antonfisher "Code") | [<img src="https://avatars1.githubusercontent.com/u/960133?v=4" width="100px;"/><br /><sub><b>Ahmad Awais ⚡️</b></sub>](https://AhmadAwais.com/)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Aahmadawais "Bug reports") [💻](https://github.com/tabrindle/envinfo/commits?author=ahmadawais "Code") | [<img src="https://avatars2.githubusercontent.com/u/9251453?v=4" width="100px;"/><br /><sub><b>Hasan</b></sub>](https://github.com/LEQADA)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3ALEQADA "Bug reports") [💻](https://github.com/tabrindle/envinfo/commits?author=LEQADA "Code") | [<img src="https://avatars3.githubusercontent.com/u/1232725?v=4" width="100px;"/><br /><sub><b>Ernesto Ramírez</b></sub>](http://twitter.com/_ErnestoR)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3AErnestoR "Bug reports") [💻](https://github.com/tabrindle/envinfo/commits?author=ErnestoR "Code") | [<img src="https://avatars1.githubusercontent.com/u/3759816?v=4" width="100px;"/><br /><sub><b>Jiawen Geng</b></sub>](https://www.gengjiawen.com)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Agengjiawen "Bug reports") [💻](https://github.com/tabrindle/envinfo/commits?author=gengjiawen "Code") [🤔](#ideas-gengjiawen "Ideas, Planning, & Feedback") [⚠️](https://github.com/tabrindle/envinfo/commits?author=gengjiawen "Tests") |
 281 | :---: | :---: | :---: | :---: | :---: | :---: | :---: |
 282 | [<img src="https://avatars3.githubusercontent.com/u/12520493?v=4" width="100px;"/><br /><sub><b>Zac Anger</b></sub>](https://zacanger.com)<br />[💻](https://github.com/tabrindle/envinfo/commits?author=zacanger "Code") [🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Azacanger "Bug reports") | [<img src="https://avatars3.githubusercontent.com/u/497214?v=4" width="100px;"/><br /><sub><b>Ville Immonen</b></sub>](https://twitter.com/VilleImmonen)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Afson "Bug reports") [💻](https://github.com/tabrindle/envinfo/commits?author=fson "Code") | [<img src="https://avatars2.githubusercontent.com/u/27246?v=4" width="100px;"/><br /><sub><b>Olmo Maldonado</b></sub>](http://ibolmo.com)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Aibolmo "Bug reports") [💻](https://github.com/tabrindle/envinfo/commits?author=ibolmo "Code") |
 283 <!-- ALL-CONTRIBUTORS-LIST:END -->
 284
 285 This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!