source: imaps-frontend/node_modules/envinfo/README.md@ 79a0317

main
Last change on this file since 79a0317 was 79a0317, checked in by stefan toskovski <stefantoska84@…>, 4 days ago

F4 Finalna Verzija
  • Property mode set to 100644
File size: 13.7 KB
Line 
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[![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-12-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
27To use as a CLI tool, install this package globally:
28
29```sh
30npm install -g envinfo || yarn global add envinfo
31```
32
33Or, use without installing with npx:
34
35`npx envinfo`
36
37To use as a library in another project:
38
39```sh
40npm 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 pnpm: 8.7.6 - /usr/local/bin/pnpm
58 bun: 1.0.2 - /usr/local/bin/bun
59 Watchman: 4.9.0 - /usr/local/bin/watchman
60 Managers:
61 Cargo: 1.31.0 - ~/.cargo/bin/cargo
62 CocoaPods: 1.7.3 - /usr/local/bin/pod
63 Composer: 1.8.6 - /usr/local/bin/composer
64 Gradle: 5.5 - /usr/local/bin/gradle
65 Homebrew: 2.1.7 - /usr/local/bin/brew
66 Maven: 3.6.1 - /usr/local/bin/mvn
67 pip2: 19.0.3 - /usr/local/bin/pip2
68 pip3: 19.0.2 - /usr/local/bin/pip3
69 RubyGems: 2.5.2.3 - /usr/bin/gem
70 Utilities:
71 CMake: 3.13.3 - /usr/local/bin/cmake
72 Make: 3.81 - /usr/bin/make
73 GCC: 10.14. - /usr/bin/gcc
74 Git: 2.20.0 - /usr/local/bin/git
75 Mercurial: 4.5.3 - /usr/bin/hg
76 Clang: 1001.0.46.4 - /usr/bin/clang
77 Subversion: 1.10.3 - /usr/bin/svn
78 Servers:
79 Apache: 2.4.34 - /usr/sbin/apachectl
80 Nginx: 1.13.12 - /usr/local/bin/nginx
81 Virtualization:
82 Docker: 18.09.1 - /usr/local/bin/docker
83 Parallels: 13.3.0 - /usr/local/bin/prlctl
84 VirtualBox: 5.2.20 - /usr/local/bin/vboxmanage
85 SDKs:
86 iOS SDK:
87 Platforms: iOS 12.2, macOS 10.14, tvOS 12.2, watchOS 5.2
88 Android SDK:
89 API Levels: 28
90 Build Tools: 28.0.3
91 System Images: android-28 | Google Play Intel x86 Atom
92 IDEs:
93 Android Studio: 3.2 AI-181.5540.7.32.5056338
94 Atom: 1.23.3
95 Emacs: 22.1.1 - /usr/bin/emacs
96 Nano: 2.0.6 - /usr/bin/nano
97 VSCode: 1.36.0 - /usr/local/bin/code
98 Vim: 8.0 - /usr/bin/vim
99 Xcode: 10.2.1/10E1001 - /usr/bin/xcodebuild
100 Languages:
101 Bash: 4.4.23 - /usr/local/bin/bash
102 Elixir: 1.6.2 - /usr/local/bin/elixir
103 Go: 1.11.1 - /usr/local/bin/go
104 Java: 1.8.0_192 - /usr/bin/javac
105 Perl: 5.18.4 - /usr/bin/perl
106 PHP: 7.1.23 - /usr/bin/php
107 Python: 2.7.16 - /usr/local/bin/python
108 Python3: 3.7.2 - /usr/local/bin/python3
109 R: 3.6.0 - /usr/local/bin/R
110 Ruby: 2.3.7 - /usr/bin/ruby
111 Rust: 1.16.0 - /Users/tabrindle/.cargo/bin/rustup
112 Databases:
113 MongoDB: 3.6.4 - /usr/local/bin/mongo
114 MySQL: 10.3.10 (MariaDB) - /usr/local/bin/mysql
115 PostgreSQL: 10.3 - /usr/local/bin/postgres
116 SQLite: 3.24.0 - /usr/bin/sqlite3
117 Browsers:
118 Chrome: 75.0.3770.100
119 Chrome Canary: 77.0.3847.0
120 Firefox: 68.0
121 Firefox Developer Edition: 69.0
122 Firefox Nightly: 69.0a1
123 Safari: 12.1.1
124 Safari Technology Preview: 13.0
125 npmPackages:
126 apollo-client: ^2.3.1 => 2.3.1
127 jest: ^22.2.1 => 22.2.1
128 ...
129 react: ^16.3.2 => 16.3.2
130 react-apollo: ^2.1.4 => 2.1.4
131 run4staged: ^1.1.1 => 1.1.1
132 solidarity: 2.0.5 => 2.0.5
133 styled-components: ^3.1.6 => 3.1.6
134 npmGlobalPackages:
135 create-react-app: 1.5.2
136 create-react-native-app: 1.0.0
137 envinfo: 5.10.0
138 exp: 49.2.2
139 gatsby-cli: 1.1.52
140 npm: 5.6.0
141 react-native-cli: 2.0.1
142 solidarity: 2.1.0
143 typescript: 2.8.1
144```
145
146## Programmatic Usage
147
148Envinfo takes a configuration object and returns a Promise that resolves a string (optionally yaml, json or markdown)
149
150```javascript
151import envinfo from 'envinfo';
152
153envinfo.run(
154 {
155 System: ['OS', 'CPU'],
156 Binaries: ['Node', 'Yarn', 'npm'],
157 Browsers: ['Chrome', 'Firefox', 'Safari'],
158 npmPackages: ['styled-components', 'babel-plugin-styled-components'],
159 },
160 { json: true, showNotFound: true }
161).then(env => console.log(env));
162```
163
164logs:
165
166```json
167{
168 "System": {
169 "OS": "macOS High Sierra 10.13",
170 "CPU": "x64 Intel(R) Core(TM) i7-4870HQ CPU @ 2.50GHz"
171 },
172 "Binaries": {
173 "Node": {
174 "version": "8.11.0",
175 "path": "~/.nvm/versions/node/v8.11.0/bin/node"
176 },
177 "Yarn": {
178 "version": "1.5.1",
179 "path": "~/.yarn/bin/yarn"
180 },
181 "npm": {
182 "version": "5.6.0",
183 "path": "~/.nvm/versions/node/v8.11.0/bin/npm"
184 }
185 },
186 "Browsers": {
187 "Chrome": {
188 "version": "67.0.3396.62"
189 },
190 "Firefox": {
191 "version": "59.0.2"
192 },
193 "Safari": {
194 "version": "11.0"
195 }
196 },
197 "npmPackages": {
198 "styled-components": {
199 "wanted": "^3.2.1",
200 "installed": "3.2.1"
201 },
202 "babel-plugin-styled-components": "Not Found"
203 }
204}
205```
206
207All 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:
208
209```javascript
210const envinfo = require('envinfo');
211
212// each helper returns a promise
213const node = await envinfo.helpers.getNodeInfo();
214
215// The promises resolve to an array of values: ["Name", "Version", "Path"]
216// e.g. ["Node", "10.9.0", "/usr/local/bin/node"]
217
218console.log(`Node: ${node[1]} - ${node[2]}`); // "Node: 10.9.0 - ~/.nvm/versions/node/v8.14.0/bin/node"
219```
220
221## CLI Options
222
223```
224 --system Print general system info such as OS, CPU, Memory and Shell
225 --browsers Get version numbers of installed web browsers
226 --SDKs Get platforms, build tools and SDKs of iOS and Android
227 --IDEs Get version numbers of installed IDEs
228 --languages Get version numbers of installed languages such as Java, Python, PHP, etc
229 --binaries Get version numbers of node, npm, watchman, etc
230 --npmPackages Get version numbers of locally installed npm packages - glob, string, or comma delimited list
231 --npmGlobalPackages Get version numbers of globally installed npm packages
232
233 --duplicates Mark duplicate npm packages inside parentheses eg. (2.1.4)
234 --fullTree Traverse entire node_modules dependency tree, not just top level
235
236 --markdown Print output in markdown format
237 --json Print output in JSON format
238 --console Print to console (defaults to on for CLI usage, off for programmatic usage)
239```
240
241## Integration
242
243envinfo is live in:
244
245- [React Native](https://github.com/facebook/react-native) (`react-native info`)
246- [Create React App](https://github.com/facebook/create-react-app) (`create-react-app --info`)
247- [Expo Environment Info](https://github.com/expo/expo-cli/tree/main/packages/expo-env-info) (`npx expo-env-info`)
248- [Webpack](https://github.com/webpack/webpack-cli) (`webpack-cli info`)
249- [Solidarity](https://github.com/infinitered/solidarity) (`solidarity report`)
250- [Gatsby](https://github.com/gatsbyjs/gatsby) (`gatsby info`)
251
252envinfo is used in the ISSUE_TEMPLATE of:
253
254- [styled-components](https://github.com/styled-components/styled-components)
255- [Jest](https://github.com/facebook/jest)
256- [Apollo Client](https://github.com/apollographql/apollo-client)
257
258## Alternatives
259
260- type `command -v` until you smash your computer
261- [screenfetch](https://github.com/KittyKatt/screenFetch) - fetch system and terminal information, and display a pretty ascii logo
262- [Solidarity](https://github.com/infinitered/solidarity) - a project based environment checker
263- write your own
264
265## License
266
267MIT
268
269## Contributing
270
271PRs for additional features are welcome! Run `npm run lint && npm run format` before committing.
272
273This 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.
274
275## Contributors
276
277Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
278
279<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
280<!-- prettier-ignore -->
281| [<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") |
282| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
283| [<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") | [<img src="https://avatars.githubusercontent.com/u/15812317?v=4" width="100px;"/><br /><sub><b>Rishabh Chawla</b></sub>](https://rishabhchawla.co)<br />[🐛](https://github.com/tabrindle/envinfo/issues?q=author%3Arishabh3112 "Bug reports") [💻](https://github.com/tabrindle/envinfo/commits?author=rishabh3112 "Code") | [<img src="https://avatars.githubusercontent.com/u/174297?v=4" width="100px;"/><br /><sub><b>Carl Taylor</b></sub>](https://github.com/Nthalk)<br />[💻](https://github.com/tabrindle/envinfo/commits?author=Nthalk "Code") |
284<!-- ALL-CONTRIBUTORS-LIST:END -->
285
286This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!
Note: See TracBrowser for help on using the repository browser.