sourcegraph/srclib-bash

Name: srclib-bash

Owner: Sourcegraph

Description: Bash toolchain for srclib

Created: 2016-06-03 20:09:03.0

Updated: 2017-06-15 18:42:02.0

Pushed: 2016-06-15 19:40:24.0

Homepage: null

Size: 3967

Language: Go

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

srclib-bash

srclib-bash is a srclib toolchain that performs Bash (and POSIX Shell) code analysis: linking command names to man pages.

It enables this functionality in any client application whose code analysis is powered by srclib, including Sourcegraph.com.

Installation

This toolchain is not a standalone program; it provides additional functionality to applications that use srclib.

First, install the srclib program (see srclib installation instructions).

Then run:

wnload and fetch dependencies
et -v sourcegraph.com/sourcegraph/srclib-bash
GOPATH/src/sourcegraph.com/sourcegraph/srclib-bash

ild the srclib-bash program in .bin/srclib-bash (this is currently required by srclib to discover the program)


nk this toolchain in your SRCLIBPATH (default ~/.srclib) to enable it

To verify that installation succeeded, run:

ib toolchain list

You should see this srclib-bash toolchain in the list.

Now that this toolchain is installed, any program that relies on srclib will support Bash.

Limitations
Known issues

srclib-bash is alpha-quality software. It powers code analysis on Sourcegraph.com but has not been widely tested or adapted for other use cases.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.