https://github.com/jornatf/letsgo-cli
Let's go commit and push in a single command line. 🚀
https://github.com/jornatf/letsgo-cli
cli command-line command-line-tool commit git javascript node nodejs npm typescript utils
Last synced: 3 months ago
JSON representation
Let's go commit and push in a single command line. 🚀
- Host: GitHub
- URL: https://github.com/jornatf/letsgo-cli
- Owner: jornatf
- License: mit
- Created: 2023-05-04T06:59:45.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-04T02:49:48.000Z (almost 3 years ago)
- Last Synced: 2025-02-08T13:37:50.469Z (over 1 year ago)
- Topics: cli, command-line, command-line-tool, commit, git, javascript, node, nodejs, npm, typescript, utils
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/letsgo-cli
- Size: 19.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# letsgo-cli
| About package | About code |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|  [](https://www.npmjs.com/package/letsgo-cli) [](LICENCE.md) | [](https://github.com/jornatf/letsgo-cli/actions?query=workflow%3Arun-tests+branch%3Amain) [](https://github.com/jornatf/letsgo-cli/actions?query=workflow%3Afix-styling-code+branch%3Amain) |
**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](https://www.npmjs.com/package/letsgo-cli)**.
#### Table of content:
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Options and commands](#options-and-commands)
- [Commands](#commands)
- [`commit`](#commit)
- [`pull`](#pull)
- [`version`](#version)
- [`help`](#help)
- [Options](#options)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)
## Prerequisites
> First, you have to install [Nodejs](https://nodejs.dev) in your machine.
## Installation
```bash
# After, install globally the package:
npm install -g letsgo-cli
```
## Usage
```txt
go [options]
```
## Commands and options
```txt
Commands:
commit [options] commits with a message
pull 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 add a tag (see commit command)
-h, --help display help for command
```
### Commands
#### `commit`
Commits and pushes in the same time.
```txt
go commit [--push | -p] [--tag |Â -t TAG] [--help | -h]
```
#### `pull`
Pulls a branch and switches in this branch if not the current.
```txt
go pull [--help | -h]
```
#### `version`
Outputs the CLI version number.
```txt
go version [--help | -h]
```
#### `help`
Displays help for commands.
```txt
go help
```
### 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](CHANGELOG.md) 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**.
>
> [](../../contributors)
## Credits
- [Jordan Nataf](https://github.com/jornatf)
- [All Contributors](../../contributors)
## Licence
The MIT License (MIT).
> Please see [License File](LICENSE.md) for more information.