source-index

command module
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 11, 2022 License: Apache-2.0 Imports: 17 Imported by: 0

README

GitHub Actions CI Status GoReportCard codebeat badge GitHub Actions CodeQL Status

InstallationUsageBuild StatusContributingLicense


SourceIndex is a simple utility for generating index page for source code archives.

Installation

To build the SourceIndex from scratch, make sure you have a working Go 1.17+ workspace (instructions), then:

go install github.com/essentialkaos/source-index

Command-line completion

You can generate completion for bash, zsh or fish shell.

Bash:

sudo source-index --completion=bash 1> /etc/bash_completion.d/source-index

ZSH:

sudo source-index --completion=zsh 1> /usr/share/zsh/site-functions/source-index

Fish:

sudo source-index --completion=fish 1> /usr/share/fish/vendor_completions.d/source-index.fish

Usage

Usage: source-index {options} dir

Options

  --output, -o file      Output file (index.html by default)
  --template, -t file    Template (template.tpl by default)
  --no-color, -nc        Disable colors in output
  --help, -h             Show this help message
  --version, -v          Show version

Build Status

Branch Status
master CI
develop CI

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL