0.1.0-0 • Published 5 years ago

stig v0.1.0-0

Weekly downloads
3
License
GPL-3.0-only
Repository
github
Last release
5 years ago

stig

A simple command line interface to read and interface with DISA STIG benchmarks

Version Downloads/week License

Introduction

This command line utility is intended to help technical folks more easily read through DISA STIG content. Every single solution that currently exists requires folks to use a UI such as the Java based STIG viewer from DISA or stigviewer.com which updates very slowly, neither are open source AFAIK.

This CLI is simple, and while it's built with nodejs it DOES NOT require you to have nodejs on your system nor will it conflict with an pre-exisiting nodejs installed on your system. Unless you install directly with npm -g the bundle you install from will contain a prebuilt node binary which will be used to invoke the CLI (invisible to you, the end user).

Once you've installed it, updates are super simple with stig update and that is it. It will periodically attempt to update itself.

This utility also does not require internet to work. All publicly available benchmarks are bundled in with the source code so there is no need for outbound access for anything other than for updates.

Table of Contents

Usage

Installers and standalone tarballs

While this utility is built with node, you do not not need node to use stig cli. You can use one of the following sources.

DEB and RPM installers are coming soon.

SystemTypeDownload Link
MacOStar.gzStable
MacOS InstallerpkgStable
Linux ARMtar.gzStable
Linux x64tar.gzStable:
Windows x64tar.gzStable
Windows x86tar.gzStable
Windows x86 InstallerexeStable
Windows x64 InstallerexeStable
Plain (requires nodejs > 10)tar.gzStable
$ npm install -g stig
$ stig COMMAND
running command...
$ stig (-v|--version|version)
stig/0.1.0-0 darwin-x64 node-v8.11.3
$ stig --help [COMMAND]
USAGE
  $ stig COMMAND
...

Commands

stig autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ stig autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ stig autocomplete
  $ stig autocomplete bash
  $ stig autocomplete zsh
  $ stig autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

stig help [COMMAND]

display help for stig

USAGE
  $ stig help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

stig update [CHANNEL]

update the stig CLI

USAGE
  $ stig update [CHANNEL]

See code: @oclif/plugin-update

Uninstallation

If you want to uninstall this there is not yet a built in uninstaller but the following should accomplish what you want. You should do this even if you install via npm.

On MacOS

rm -rf ~/Library/Caches/stig
rm -rf ~/.local/share/stig
rm -rf ~/.data/stig
sudo rm `which stig`

On Linux

rm -rf ~/.cache/stig
rm -rf ~/.data/stig
sudo rm `which stig`

On Windows TBD pending testing