Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/gosec.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: gosec
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:

jobs:
gosec:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Run Gosec Security Scanner
uses: securego/gosec@master
with:
args: ./...
28 changes: 28 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: test
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:

jobs:
test:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3

- name: Set up Go
uses: actions/setup-go@v3
with:
go-version: "1.24.0"

- name: Run tests
run: go test ./... --coverprofile=coverage.txt

- name: Upload results to Codecov
uses: codecov/codecov-action@v3.0.0
with:
files: coverage.txt
token: "${{ secrets.CODECOV_TOKEN }}"
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# `cli`

[![Go Reference](https://pkg.go.dev/badge/github.com/broothie/cli.svg)](https://pkg.go.dev/github.com/broothie/cli)
[![Go Report Card](https://goreportcard.com/badge/github.com/broothie/cli)](https://goreportcard.com/report/github.com/broothie/cli)
[![codecov](https://codecov.io/gh/broothie/cli/graph/badge.svg?token=GdWFdveewo)](https://codecov.io/gh/broothie/cli)
[![gosec](https://github.com/broothie/cli/actions/workflows/gosec.yml/badge.svg)](https://github.com/broothie/cli/actions/workflows/gosec.yml)

A Go package for building CLIs.

## Installation

```shell
go get github.com/broothie/cli@latest
```

## Documentation

https://pkg.go.dev/github.com/broothie/cli

## To Do

- [ ] Audit bare `err` returns
- [ ] Two types of errors: config and parse
- [ ] Tab completion
- [ ] Allow variadic arguments
- [ ] Allow slice and map based flags?
21 changes: 0 additions & 21 deletions readme.md

This file was deleted.