gitdig

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="description" content="Get Help to the gitdig."> <meta name="author" content="Tamás Benke"> <meta name="Keywords" content="rest, restful, utility, tools, gitdig, node.js, api, development" /> <link rel="shortcut icon" href="../../assets/ico/favicon.ico"> <title>gitdig</title>  <link href="bootstrap/css/bootstrap.min.css" rel="stylesheet">  <link href="jumbotron-narrow.css" rel="stylesheet">     </head> <body> <div class="container"> <div class="header"> <ul class="nav nav-pills pull-right"> <li><a href="../index.html">Home</a></li> <li><a href="about.html">About</a></li> <li><a href="getStarted.html">Get Started</a></li> <li><a href="changelog.html">Blog</a></li> <li><a href="documentation.html">Documentation</a></li> <li><a href="docs/examples.html">Examples</a></li> <li><a href="getHelp.html">Get Help</a></li> </ul> <h3 class="text-muted">gitdig</h3> </div> <div class="row marketing"> <div class="col-lg-12"> <h1 id="get-started">Get Started</h1> <h2 id="installation">Installation</h2> <h3 id="prerequisites-">Prerequisites:</h3> <p><code>gitdig</code> needs <a href="http://nodejs.org/">Node.js</a> and <a href="https://npmjs.org/">NPM</a> installed on the machine, before start installing and using it.</p> <h3 id="installation-steps">Installation steps</h3> <p>The <code>gitdig</code> tool can be installed as any other node module, but you have to install to the global node_modules folder, so use the <code>-g</code> switch to <code>npm</code>.</p> <p>To install <code>gitdig</code>, execute the following command:</p> <pre><code>$ npm install -g gitdig </code></pre><p>To check, whether gitdig is installed successfully, run the following command:</p> <pre><code>$ gitdig -V </code></pre><h2 id="usage-of-the-gitdig-utility">Usage of the <code>gitdig</code> utility</h2> <h3 id="get-help">Get Help</h3> <p>Check if gitdig is properly installed:</p> <pre><code class="lang-bash"> $ gitdig -h Usage: gitdig [options] [command] Commands: collect [options] Collect data about repositories, through a selected user account, and make a local snapshot file. ls [options] List the repositories check [options] Check the repositories Options: -h, --help output usage information -V, --version output the version number </code></pre> <p>Get help for individual commands, such as, <code>collect</code>, <code>ls</code> or <code>check</code>:</p> <pre><code class="lang-bash"> $ gitdig ls -h Usage: ls [options] Options: -h, --help output usage information -l, --long Long format, including some details -c, --config [config file name] The name of the config file to use -u, --git-user [user name] The git account -s, --snapshot [snapshot file name] Define the file name for the local snapshot repo summaries -o, --offline Use the local snapshot (offline mode) </code></pre> <h3 id="get-a-list-of-the-repositories-you-have-access">Get a list of the repositories you have access</h3> <p>The following command retrieves the summaries of all the repositories you have access, then stores it into a snapshot file, and finally lists the names of the repositories found.</p> <p>Replace the tombenke username with your git account name.</p> <pre><code class="lang-bash"> $ gitdig ls -u tombenke -s repos.json password: ********** get package.json from tombenke/1wire-relay-hw... get package.json from tombenke/cogito... get package.json from tombenke/contacts... get package.json from tombenke/couchme... get package.json from tombenke/csvconv... get package.json from tombenke/darduino... ... tombenke/1wire-relay-hw tombenke/cogito tombenke/contacts tombenke/couchme tombenke/csvconv tombenke/darduino ... </code></pre> <p>The command has created a snapshot file with <code>repos.json</code>. Check the content:</p> <pre><code class="lang-bash"> $ head repos.json [ { "name": "1wire-relay-hw", "owner": "tombenke", "private": false, "description": "1-wire port extender hardware module with relays", "homepage": null, "html_url": "https://github.com/tombenke/1wire-relay-hw", "git_url": "git://github.com/tombenke/1wire-relay-hw.git", "tags": [], </code></pre> <p>Now you have a snapshot, so you can get a list again, without connecting to the GitHub, if you use the -o (offline) switch. You also can use the -l (long) switch to see more details:</p> <pre><code class="lang-bash"> $ gitdig ls -u tombenke -s repos.json -o -l tombenke/1wire-relay-hw - (public) 1-wire port extender hardware module with relays [] tombenke/cogito - (public) CouchDB based GTD -like web application [] tombenke/contacts - (public) A sample web application project, using CouchDb, Node.js and ExtJS [] tombenke/couchme - (public) Readings about how to develop web applications with CouchDB and CouchApp for beginners (Hungarian) [] tombenke/csvconv - (public) CSV converter utility [] tombenke/darduino - (public) Dockerized Arduino IDE [] tombenke/deagle - (public) The CadSoft EAGLE is dockerized and runs directly from the container [] tombenke/dmos - (public) Dockerized Mongoose-OS tools [] tombenke/fl2esd - (public) Command line utility which converts FluentD format log entries to elasticdump friendly format ["cli","util","tool","utility","elasticdump","elasticsearch","fluentd"] </code></pre> <p>Or you can make a check on the repos, either on-line or off-line:</p> <pre><code class="lang-bash"> $ gitdig check -u tombenke -s repos.json -o tombenke/1wire-relay-hw warning No package.json info found! tombenke/cogito warning No package.json info found! tombenke/contacts warning No package.json info found! tombenke/couchme warning No package.json info found! tombenke/csvconv warning No package.json info found! tombenke/darduino warning No package.json info found! ... 254 problems (128 errors, 126 warnings) </code></pre> <p>In order to learn more about how to use the tool, read the <a href="documentation.html">documentation</a> pages.</p> </div> </div> <div class="footer"> <p class="copyright">gitdig is maintained by <a href="https://github.com/tombenke">tombenke</a><br> Theme borrowed from <a href="http://getbootstrap.com/examples/jumbotron-narrow/">Bootstrap</a></p> </div> </div>    </body> </html>