Skip to content

Latest commit

 

History

History
156 lines (107 loc) · 2.59 KB

USAGE.md

File metadata and controls

156 lines (107 loc) · 2.59 KB

Usage

$ ghproj --help
NAME:
   ghproj - A new cli application

USAGE:
   ghproj [global options] command [command options]

VERSION:
   0.1.5 (1de91ad7a58ca59524bcc5e687e74e3a388a365d)

COMMANDS:
   init        Scaffold a configuration file
   add         Add GitHub Issues and Pull Requests to GitHub Projects
   completion  Output shell completion script for bash, zsh, or fish
   version     Show version
   help, h     Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --log-level value  log level
   --log-color value  Log color. One of 'auto' (default), 'always', 'never'
   --help, -h         show help
   --version, -v      print the version

ghproj init

$ ghproj init --help
NAME:
   ghproj init - Scaffold a configuration file

USAGE:
   ghproj init

DESCRIPTION:
   Scaffold a configuration file.

   $ ghproj init


OPTIONS:
   --help, -h  show help

ghproj add

$ ghproj add --help
NAME:
   ghproj add - Add GitHub Issues and Pull Requests to GitHub Projects

USAGE:
   ghproj add [command options]

DESCRIPTION:
   Add GitHub Issues and Pull Requests to GitHub Projects.

   $ ghproj add


OPTIONS:
   --config value, -c value  configuration file path [$GHPROJ_CONFIG]
   --help, -h                show help

ghproj completion

$ ghproj completion --help
NAME:
   ghproj completion - Output shell completion script for bash, zsh, or fish

USAGE:
   ghproj completion command [command options]

DESCRIPTION:
   Output shell completion script for bash, zsh, or fish.
   Source the output to enable completion.

   e.g.

   .bash_profile

   source <(ghproj completion bash)

   .zprofile

   source <(ghproj completion zsh)

   fish

   ghproj completion fish > ~/.config/fish/completions/ghproj.fish

ghproj completion bash

$ ghproj completion bash --help
NAME:
    - Output shell completion script for bash

USAGE:
    [command options]

OPTIONS:
   --help, -h  show help

ghproj completion zsh

$ ghproj completion zsh --help
NAME:
    - Output shell completion script for zsh

USAGE:
    [command options]

OPTIONS:
   --help, -h  show help

ghproj completion fish

$ ghproj completion fish --help
NAME:
    - Output shell completion script for fish

USAGE:
    [command options]

OPTIONS:
   --help, -h  show help

ghproj version

$ ghproj version --help
NAME:
   ghproj version - Show version

USAGE:
   ghproj version [command options]

OPTIONS:
   --help, -h  show help