https://github.com/dawsbot/sist

Print system information in markdown
https://github.com/dawsbot/sist

debug documentation documentation-generator github markdown md

Last synced: about 19 hours ago
JSON representation

Print system information in markdown

• Host: GitHub
• URL: https://github.com/dawsbot/sist
• Owner: dawsbot
• License: mit
• Created: 2016-02-25T18:45:11.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2021-12-02T11:03:21.000Z (about 4 years ago)
• Last Synced: 2025-11-27T10:36:58.673Z (2 months ago)
• Topics: debug, documentation, documentation-generator, github, markdown, md
• Language: JavaScript
• Homepage:
• Size: 778 KB
• Stars: 6
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Contributing: .github/contributing.md
  • License: license

Awesome Lists containing this project

README

          
# sist

[![npm version](https://img.shields.io/npm/v/sist.svg)](https://www.npmjs.com/package/sist)

[![Build Status](https://travis-ci.org/dawsbot/sist.svg?branch=master)](https://travis-ci.org/dawsbot/sist)

[![npm download count](http://img.shields.io/npm/dm/sist.svg?style=flat)](http://npmjs.org/sist)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

> cli to print system information in markdown format




## Demo

![demo](./demo.gif)




## Install

```

$ npm install -g sist

```




## Usage

```

$ sist shell node

### shell  

`uname`: Darwin

`echo $SHELL`: /bin/zsh

`echo $TERM`: xterm-256color

`echo $TERM_PROGRAM`: iTerm.app

### node  

`npm -v`: 3.6.0

`node --version`: v5.6.0

Time created: Mon Feb 29 2016 00:14:54 GMT-0500 (EST)

```




---

Sist outputs markdown. This means that it gets parsed beautifully in GitHub **issues**, **pull requests**, and **wiki's**.

### shell  

`uname`: Darwin  

`echo $SHELL`: /bin/zsh  

`echo $TERM`: xterm-256color  

`echo $TERM_PROGRAM`: iTerm.app  

### node  

`npm -v`: 3.6.0  

`node --version`: v5.6.0  

Time created: Mon Feb 29 2016 00:14:54 GMT-0500 (EST)




---

Tell your users to create issues using sist by placing information in [.github/issue_template.md](.github/issue_template.md)




## More help

```

$ sist --help

  Usage

    sist [languages]

  Examples

    $ sist ruby

      [sist](https://github.com/dawsonbotsford/sist) output:

      ### ruby  

      `ruby --version`: ruby 2.2.1p85 (2015-02-26 revision 49769) [x86_64-darwin14]

      Time created: Thu Mar 03 2016 12:48:02 GMT-0700 (MST)

    $ sist shell go

      [sist](https://github.com/dawsonbotsford/sist) output:

      ### shell  

      `uname`: Darwin

      `echo $SHELL`: /bin/zsh

      `echo $TERM`: xterm-256color

      `echo $TERM_PROGRAM`: iTerm.app

      `a`: `error, return code 127`

      ### go  

      `go --version`: `error, return code 127`

      Time created: Thu Mar 03 2016 12:48:39 GMT-0700 (MST)

```




## License

MIT © [Dawson Botsford](http://dawsonbotsford.com)




---

If you like this, star it. If you want to follow me, follow me.