Skip to content

Test out the vanity URL #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
FollowTheProcess wants to merge 1 commit into from
Closed

Test out the vanity URL #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# CLI

[![License](https://img.shields.io/github/license/FollowTheProcess/cli)](https://github.com/FollowTheProcess/cli)
[![Go Reference](https://pkg.go.dev/badge/github.com/FollowTheProcess/cli.svg)](https://pkg.go.dev/github.com/FollowTheProcess/cli)
[![Go Report Card](https://goreportcard.com/badge/github.com/FollowTheProcess/cli)](https://goreportcard.com/report/github.com/FollowTheProcess/cli)
[![GitHub](https://img.shields.io/github/v/release/FollowTheProcess/cli?logo=github&sort=semver)](https://github.com/FollowTheProcess/cli)
[![CI](https://github.com/FollowTheProcess/cli/workflows/CI/badge.svg)](https://github.com/FollowTheProcess/cli/actions?query=workflow%3ACI)
[![License](https://img.shields.io/github/license/FollowTheProcess/cli)](https://followtheprocess.codes/cli)
[![Go Reference](https://pkg.go.dev/badge/followtheprocess.codes/cli.svg)](https://pkg.go.dev/followtheprocess.codes/cli)
[![Go Report Card](https://goreportcard.com/badge/followtheprocess.codes/cli)](https://goreportcard.com/report/followtheprocess.codes/cli)
[![GitHub](https://img.shields.io/github/v/release/FollowTheProcess/cli?logo=github&sort=semver)](https://followtheprocess.codes/cli)
[![CI](https://followtheprocess.codes/cli/workflows/CI/badge.svg)](https://followtheprocess.codes/cli/actions?query=workflow%3ACI)
[![codecov](https://codecov.io/gh/FollowTheProcess/cli/branch/main/graph/badge.svg)](https://codecov.io/gh/FollowTheProcess/cli)

Tiny, simple, but powerful CLI framework for modern Go 🚀

<p align="center">
<img src="https://github.com/FollowTheProcess/cli/raw/main/docs/img/demo.png" alt="demo">
<img src="https://followtheprocess.codes/cli/raw/main/docs/img/demo.png" alt="demo">
</p>

> [!WARNING]
Expand Down Expand Up @@ -40,7 +40,7 @@ Tiny, simple, but powerful CLI framework for modern Go 🚀
## Installation

```shell
go get github.com/FollowTheProcess/cli@latest
go get followtheprocess.codes/cli@latest
```

## Quickstart
Expand All @@ -52,7 +52,7 @@ import (
"fmt"
"os"

"github.com/FollowTheProcess/cli"
"followtheprocess.codes/cli"
)

func main() {
Expand Down Expand Up @@ -95,10 +95,10 @@ func runQuickstart(count *int) func(cmd *cli.Command, args []string) error {

Will get you the following:

![quickstart](https://github.com/FollowTheProcess/cli/raw/main/docs/img/quickstart.gif)
![quickstart](https://followtheprocess.codes/cli/raw/main/docs/img/quickstart.gif)

> [!TIP]
> See usage section below and more examples under [`./examples`](https://github.com/FollowTheProcess/cli/tree/main/examples)
> See usage section below and more examples under [`./examples`](https://followtheprocess.codes/cli/tree/main/examples)

## Usage

Expand All @@ -119,7 +119,7 @@ cmd, err := cli.New(
```

> [!TIP]
> The command can be customised by applying any number of [functional options] for setting the help text, describing the arguments or flags it takes, adding subcommands etc. see <https://pkg.go.dev/github.com/FollowTheProcess/cli#Option>
> The command can be customised by applying any number of [functional options] for setting the help text, describing the arguments or flags it takes, adding subcommands etc. see <https://pkg.go.dev/followtheprocess.codes/cli#Option>

### Sub Commands

Expand Down
2 changes: 1 addition & 1 deletion Taskfile.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ version: "3"

vars:
COV_DATA: coverage.out
PACKAGE: github.com/FollowTheProcess/cli
PACKAGE: followtheprocess.codes/cli

tasks:
default:
Expand Down
2 changes: 1 addition & 1 deletion args.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package cli
package cli // import "followtheprocess.codes/cli"

import (
"fmt"
Expand Down
2 changes: 1 addition & 1 deletion args_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"slices"
"testing"

"github.com/FollowTheProcess/cli"
"followtheprocess.codes/cli"
"github.com/FollowTheProcess/test"
)

Expand Down
8 changes: 4 additions & 4 deletions command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
// Package cli provides a clean, minimal and simple mechanism for constructing CLI commands.
package cli
package cli // import "followtheprocess.codes/cli"

import (
"errors"
Expand All @@ -10,9 +10,9 @@ import (
"strings"
"unicode/utf8"

"github.com/FollowTheProcess/cli/internal/colour"
"github.com/FollowTheProcess/cli/internal/flag"
"github.com/FollowTheProcess/cli/internal/table"
"followtheprocess.codes/cli/internal/colour"
"followtheprocess.codes/cli/internal/flag"
"followtheprocess.codes/cli/internal/table"
)

const (
Expand Down
2 changes: 1 addition & 1 deletion command_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
"slices"
"testing"

"github.com/FollowTheProcess/cli"
"followtheprocess.codes/cli"
"github.com/FollowTheProcess/snapshot"
"github.com/FollowTheProcess/test"
)
Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@ A CLI with named positional arguments that may or may not have default values. S
- Docker
- Cargo

[quickstart]: <https://github.com/FollowTheProcess/cli#quickstart>
[quickstart]: <https://followtheprocess.codes/cli#quickstart>
[freeze]: <https://github.com/charmbracelet/freeze>
2 changes: 1 addition & 1 deletion examples/cover/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"log"
"os"

"github.com/FollowTheProcess/cli"
"followtheprocess.codes/cli"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion examples/namedargs/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"fmt"
"os"

"github.com/FollowTheProcess/cli"
"followtheprocess.codes/cli"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion examples/quickstart/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"fmt"
"os"

"github.com/FollowTheProcess/cli"
"followtheprocess.codes/cli"
)

func main() {
Expand Down
2 changes: 1 addition & 1 deletion examples/subcommands/cli.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"strings"
"time"

"github.com/FollowTheProcess/cli"
"followtheprocess.codes/cli"
)

func BuildCLI() (*cli.Command, error) {
Expand Down
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module github.com/FollowTheProcess/cli
module followtheprocess.codes/cli

go 1.24

Expand Down
2 changes: 1 addition & 1 deletion internal/flag/flag_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import (
"testing"
"time"

"github.com/FollowTheProcess/cli/internal/flag"
"followtheprocess.codes/cli/internal/flag"
"github.com/FollowTheProcess/test"
)

Expand Down
4 changes: 2 additions & 2 deletions internal/flag/set.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import (
"slices"
"strings"

"github.com/FollowTheProcess/cli/internal/colour"
"github.com/FollowTheProcess/cli/internal/table"
"followtheprocess.codes/cli/internal/colour"
"followtheprocess.codes/cli/internal/table"
)

// usageBufferSize is sufficient to hold most commands flag usage text.
Expand Down
4 changes: 2 additions & 2 deletions internal/flag/set_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import (
"slices"
"testing"

"github.com/FollowTheProcess/cli/internal/colour"
"github.com/FollowTheProcess/cli/internal/flag"
"followtheprocess.codes/cli/internal/colour"
"followtheprocess.codes/cli/internal/flag"
"github.com/FollowTheProcess/snapshot"
"github.com/FollowTheProcess/test"
)
Expand Down
2 changes: 1 addition & 1 deletion internal/table/table_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"fmt"
"testing"

"github.com/FollowTheProcess/cli/internal/table"
"followtheprocess.codes/cli/internal/table"
"github.com/FollowTheProcess/snapshot"
"github.com/FollowTheProcess/test"
)
Expand Down
6 changes: 3 additions & 3 deletions option.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package cli
package cli // import "followtheprocess.codes/cli"

import (
"errors"
Expand All @@ -7,8 +7,8 @@ import (
"slices"
"strings"

"github.com/FollowTheProcess/cli/internal/colour"
"github.com/FollowTheProcess/cli/internal/flag"
"followtheprocess.codes/cli/internal/colour"
"followtheprocess.codes/cli/internal/flag"
)

// NoShortHand should be passed as the "short" argument to [Flag] if the desired flag
Expand Down
Loading