README.md

letsgo-cli

About package	About code

Let's go commit and push in a single command line. 🚀

This CLI is intended to help you commit and push your changes simply with the least command line. Other commands allow you to go faster. Find it out in the NPM Registry.

Table of content:

• Prerequisites
• Installation
• Usage
• Options and commands
  • Commands
    • commit
    • pull
    • version
    • help
  • Options
• Changelog
• Contributing
• Credits
• License

Prerequisites

First, you have to install Nodejs in your machine.

Installation

# After, install globally the package:
npm install -g letsgo-cli

Usage

go [options] <command>

Commands and options

Commands:
  commit [options] <message>  commits with a message
  pull <branch_name>          pulls the latest changes from a specific branch and switches if it's
                              different from the current branch
  version                     display the version number
  help [command]              display help for command

Options:
  -V, --version               output the version number
  -p, --push                  push after commit (see commit command)
  -t, --tag <tag_name>        add a tag (see commit command)
  -h, --help                  display help for command

Commands

commit

Commits and pushes in the same time.

go commit [--push | -p] [--tag | -t TAG] [--help | -h] <message>

pull

Pulls a branch and switches in this branch if not the current.

go pull [--help | -h] <branch_name>

version

Outputs the CLI version number.

go version [--help | -h]

help

Displays help for commands.

go help <command>

Options

Key	Description
--version, -V	output the CLI version number
--push, -p	push after commit (see commit command)
--tag, t	add a tag (see commit command)
--help, -h	display help for command

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

If you are interested in this project and want to improve it, fix errors or bugs, you're welcome to contribute.

Credits

• Jordan Nataf
• All Contributors

Licence

The MIT License (MIT).

Please see License File for more information.