https://github.com/eugenmayer/go-shell-cli-quickstarter
Boilerplate to bootstrap you go-cli project and replace bash - pragmaticly
https://github.com/eugenmayer/go-shell-cli-quickstarter
bash cli-command exec golang scp ssh
Last synced: 6 months ago
JSON representation
Boilerplate to bootstrap you go-cli project and replace bash - pragmaticly
- Host: GitHub
- URL: https://github.com/eugenmayer/go-shell-cli-quickstarter
- Owner: EugenMayer
- License: mit
- Created: 2018-10-26T14:35:17.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-25T16:00:03.000Z (over 2 years ago)
- Last Synced: 2025-04-12T20:53:30.545Z (6 months ago)
- Topics: bash, cli-command, exec, golang, scp, ssh
- Language: Go
- Homepage:
- Size: 39.1 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## WAT
This boilerplate / starter should help you to replace a bash script as fast as possible - run `./create-my-project.sh` and start right away with your business logic.
It should be transparent, you should be able to understand what is happening and go as deep into the matter as you like.
It should be easy to understand, all implementations in cmd/ are small and specific so you can junk them together and chain them.
It should help you
- **get the job done. Period.** (not teach you go concepts all over the place)
- be documented .. right.
- handling script parameters and options using the [cobra](https://github.com/spf13/cobra) lib
- running cli commands on the shell with proper stdin/stdout/err handling easily: [go-exec](https://github.com/EugenMayer/go-exec)
- running cli commands over ssh utilizing your ssh-agent/privkey/password easily: [go-sshclient](https://github.com/EugenMayer/go-sshclient)
- transferring files from and to remote server using scp easily: [go-sshclient](https://github.com/EugenMayer/go-sshclient)
- Include IntelliJ run configuration to run/debug the tasks right away
**Why not learning all the deeper concepts?**
Well you could .. but that stops most people from using golang over bash in the smaller, daily projects.
So you will learn the deeper parts every time you write something, part by part - but that happens as a side-track, while
you actually get your job done
## Get started
You can generate a new project for yourself using this boilerplate
This will generate a new shell-project with the name 'mycliname' in `/tmp/mycliname` - you can open the folder using your
IDE and start developing right away
```bash
./create-my-project.sh --project=mycliname --username=ghusername --strip-ssh
# or with private SCM
./create-my-project.sh --project=mycliname --username=ghusername --host=ourprivate-scm.tld --strip-ssh
```
You most probably want to `mv` the project from `/tmp` into a folder for your scm prjects.
### Parameters
- `--project` - The name of your CLI program that you are planning (`mycliname` in the examples).
- `--username` - Your namespace, usually your GitHub username (`ghusername` in the examples).
- `--strip-ssh` (optional) - Will remove the `ssh` and `scp` examples from the starter, including all of it's dependencies for a slim and stripped down project.
- `--host` (optional) - Your private VCS domain (without scheme).
That's it, read the shell output and you are ready and set to start creating.
## Included examples
I did ship `dist/mycli*` in the repo for convenience reasons for now, so you do neither need to `build` yourself nor us `curl`
Generally depending on your use, use `mycli-macos` or `mycli-linux`
### Exec
```bash
dist/mycli-macos myexec --cmd="echo hi"
```
### SSH
If you want to the the ssh command, just use the local `docker-compose.yml` to start a local `ssh node`
```
docker-compose up -d
dist/mycli-macos myssh --host=localhost --port=2301 --key=test/sshkeys/id_rsa
```
### SCP
If you want to the the ssh command, just use the local `docker-compose.yml` to start a local `ssh node`
```bash
docker-compose up -d
dist/mycli-macos myscp --host=localhost --port=2301 --key=test/sshkeys/id_rsa --file=test/dummytestfile
```
## Build this project yourself
```bash
make build
```