https://github.com/peter-mcconnell/skeleton
Just a few nuts and bolts that I tend to use when starting projects. Any suggestions welcome!
https://github.com/peter-mcconnell/skeleton
circleci shell skeleton template
Last synced: 12 months ago
JSON representation
Just a few nuts and bolts that I tend to use when starting projects. Any suggestions welcome!
- Host: GitHub
- URL: https://github.com/peter-mcconnell/skeleton
- Owner: peter-mcconnell
- License: mit
- Created: 2019-10-21T20:00:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-10-22T21:04:53.000Z (over 6 years ago)
- Last Synced: 2025-07-07T01:04:24.145Z (12 months ago)
- Topics: circleci, shell, skeleton, template
- Language: Shell
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
skeleton
===
`foo` is a tool for ... It requires no internet connection to run, nor does it depend on any external libraries.
[](https://circleci.com/gh/pemcconnell/skeleton/tree/master)
## install
`go get -u github.com/pemcconnell/foo`
Alternatively you can download a binary suited for your distribution and architecture via the [releases](releases) page.
## usage
In its simplest form you can just run `foo` and will print the result to stdout.
```sh
foo
```
## flags
You can view the flags at any time using `foo -h`.
If you would like to instruct `foo` to print results to a particular file you can run:
```sh
foo --out foo.json
# save output to foo.json. This is the same as running foo > foo.json, with some additional helper output
```
## development
### dependencies
- `hadolint`
- `shellcheck`
- `docker`
- `bats`
### build
```sh
./build.sh
```
### test
```sh
./test.sh
```
### clean
```sh
sh clean.sh
```
## contributing
All contributions welcome! Please check [CONTRIBUTING.md](CONTRIBUTING.md) for some guidance.