Skip to content

Latest commit

 

History

History
96 lines (78 loc) · 2.09 KB

README.md

File metadata and controls

96 lines (78 loc) · 2.09 KB

gogi: A simple .gitignore template manager

Installation

Deploy Gogi with the following command:

go install github.com/SQUASHD/gogi@latest

the installation process for gogi

Configuration

Initialize Gogi to set up a dedicated template directory within your .config folder:

gogi init

Template Management

using gogi Craft a new, blank template

gogi create <template-name> [-e open in editor] [-b set as base]

Specify your preferred editor for template customization:

gogi editor <editor-name>

Modify an existing template to suit your project needs:

gogi edit <template-name>

Establish a default template for new projects:

gogi base <template-name>

Delete an outdated template

gogi delete <template-name> [--force will override the are you sure prompt]

Generate .gitignore

Generate a .gitignore file using your base template directly in your current project directory:

gogi

If you need a different template you can use gogi generate to generate a new .gitignore file

gogi generate <template-name> [--force will overwrite the current .gitignore]

Or append the current .gitignore with a different template

gogi append <template-name>

Assistance

   alias: Show the list of avaiable command aliases
  append: Append a template to an existing gitignore file
    base: set the base template that you call with gogi with no args
  create: Create a new template
  delete: Delete an existing gitignore alias
    edit: Edit an existing template
  editor: Set the editor to use for editing templates
generate: Generate a gitignore file from the given template
    help: Display help message, or help for a specific command
    list: List all the templates
  rename: Rename a template

Most commands have an alias corresponding to their first letter

a -> append
b -> base
c -> create
d -> delete
e -> edit
g -> generate
h -> help
l -> list
r -> rename

See the whole suite of Gogi commands at any point

gogi help