Skip to content

Commit e07b7e0

Browse files
authored
Merge branch 'main' into dev
2 parents 5dac174 + c24827d commit e07b7e0

File tree

7 files changed

+22
-22
lines changed

7 files changed

+22
-22
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,15 @@
4040
</a>
4141
</p>
4242

43-
Console is an all-in-one console application library built on top of a [readline](https://github.com/reeflective/readline) shell and using [Cobra](https://github.com/spf13/cobra) commands.
44-
It aims to provide users with a modern interface at at minimal cost while allowing them to focus on developing
43+
Console is an all-in-one console application library built on top of a [readline](https://github.com/reeflective/readline) shell and using [Cobra](https://github.com/spf13/cobra) commands.
44+
It aims to provide users with a modern interface at at minimal cost while allowing them to focus on developing
4545
their commands and application core: the console will then transparently interface with these commands, and provide
4646
the various features below almost for free.
4747

4848

4949
## Features
5050

51-
### Menus & Commands
51+
### Menus & Commands
5252
- Bind cobra commands to provide the core functionality.
5353
- Multiple menus with their own command tree, prompt engines and special handlers.
5454
- All cobra settings can be modified, set and used freely, like in normal CLI workflows.
@@ -59,7 +59,7 @@ the various features below almost for free.
5959
- All features of readline are supported in the console. It also allows the console to give:
6060
- Configurable bind keymaps, commands and options, sane defaults, and per-application configuration.
6161
- Out-of-the-box, advanced completions for commands, flags, positional and flag arguments.
62-
- Provided by readline and [carapace](https://github.com/rsteube/carapace): automatic usage & validation command/flags/args hints.
62+
- Provided by readline and [carapace](https://github.com/carapace-sh/carapace): automatic usage & validation command/flags/args hints.
6363
- Syntax highlighting for commands (might be extended in the future).
6464

6565
### Others
@@ -71,11 +71,11 @@ the various features below almost for free.
7171

7272
## Documentation
7373

74-
You can install and use the [example application console](https://github.com/reeflective/console/tree/main/example). This example application
75-
will give you a taste of the behavior and supported features. The following documentation
74+
You can install and use the [example application console](https://github.com/reeflective/console/tree/main/example). This example application
75+
will give you a taste of the behavior and supported features. The following documentation
7676
is also available in the [wiki](https://github.com/reeflective/console/wiki):
7777

78-
* [Getting started](https://github.com/reeflective/console/wiki/Getting-Started)
78+
* [Getting started](https://github.com/reeflective/console/wiki/Getting-Started)
7979
* [Menus](https://github.com/reeflective/console/wiki/Menus)
8080
* [Prompts](https://github.com/reeflective/console/wiki/Prompts)
8181
* [Binding commands](https://github.com/reeflective/console/wiki/Binding-Commands)
@@ -90,12 +90,12 @@ is also available in the [wiki](https://github.com/reeflective/console/wiki):
9090
![console](https://github.com/reeflective/console/blob/assets/console.gif)
9191

9292

93-
## Status
93+
## Status
9494

9595
The library is in a pre-release candidate status:
9696
- Although quite simple and small, it has not been tested heavily.
9797
- There are probably some features/improvements to be made.
9898
- The API is quite stable. It is unlikely to change much in future versions.
9999

100-
Please open a PR or an issue if you wish to bring enhancements to it.
100+
Please open a PR or an issue if you wish to bring enhancements to it.
101101
Other contributions, as well as bug fixes and reviews are also welcome.

commands/readline/bind.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import (
66
"os"
77
"strings"
88

9-
"github.com/rsteube/carapace"
9+
"github.com/carapace-sh/carapace"
1010
"github.com/spf13/cobra"
1111

1212
"github.com/reeflective/readline"
@@ -22,7 +22,7 @@ func Bind(shell *readline.Shell) *cobra.Command {
2222
2323
Changing binds:
2424
Note that the keymap name is optional, and if omitted, the default keymap is used.
25-
The default keymap is 'vi' only if 'set editing-mode vi' is found in inputrc , and
25+
The default keymap is 'vi' only if 'set editing-mode vi' is found in inputrc , and
2626
unless the -m option is used to set a different keymap.
2727
Also, note that the bind [seq] [command] slightly differs from the original bash 'bind' command.
2828

commands/readline/completers.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ package readline
2121
import (
2222
"fmt"
2323

24-
"github.com/rsteube/carapace"
24+
"github.com/carapace-sh/carapace"
2525
"github.com/spf13/cobra"
2626

2727
"github.com/reeflective/readline"

commands/readline/set.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ import (
55
"strconv"
66
"strings"
77

8-
"github.com/rsteube/carapace"
9-
"github.com/rsteube/carapace/pkg/style"
8+
"github.com/carapace-sh/carapace"
9+
"github.com/carapace-sh/carapace/pkg/style"
1010
"github.com/spf13/cobra"
1111
"golang.org/x/exp/maps"
1212
"golang.org/x/exp/slices"

example/main-commands.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import (
66
"os/exec"
77
"strings"
88

9-
"github.com/rsteube/carapace"
9+
"github.com/carapace-sh/carapace"
1010
"github.com/spf13/cobra"
1111
"github.com/spf13/pflag"
1212

go.mod

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ module github.com/reeflective/console
33
go 1.23.6
44

55
require (
6-
github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc51
6+
github.com/carapace-sh/carapace v1.7.1
7+
github.com/kballard/go-shellquote v0.0.0-20180428030007-95032a82bc5
78
github.com/reeflective/readline v1.1.3
89
github.com/rsteube/carapace v0.46.3-0.20231214181515-27e49f3c3b69
910
github.com/spf13/cobra v1.8.1
@@ -13,6 +14,7 @@ require (
1314
)
1415

1516
require (
17+
github.com/carapace-sh/carapace-shlex v1.0.1 // indirect
1618
github.com/inconshreveable/mousetrap v1.1.0 // indirect
1719
github.com/rivo/uniseg v0.4.7 // indirect
1820
github.com/rsteube/carapace-shlex v0.1.1 // indirect

go.sum

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
1+
github.com/carapace-sh/carapace v1.7.1 h1:GjMjPNEMHhTstneZD2M3Ypjb+lW5YNEV1AfYmRhsG4c=
2+
github.com/carapace-sh/carapace v1.7.1/go.mod h1:fHdo3nEFe1QnIXxeA/Z1O9dCI83sfCsKfxrogpHfgtM=
3+
github.com/carapace-sh/carapace-shlex v1.0.1 h1:ww0JCgWpOVuqWG7k3724pJ18Lq8gh5pHQs9j3ojUs1c=
4+
github.com/carapace-sh/carapace-shlex v1.0.1/go.mod h1:lJ4ZsdxytE0wHJ8Ta9S7Qq0XpjgjU0mdfCqiI2FHx7M=
25
github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
36
github.com/frankban/quicktest v1.14.5 h1:dfYrrRyLtiqT9GyKXgdh+k4inNeTvmGbuSgZ3lx3GhA=
47
github.com/frankban/quicktest v1.14.5/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0=
@@ -21,12 +24,7 @@ github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
2124
github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
2225
github.com/rogpeppe/go-internal v1.10.1-0.20230524175051-ec119421bb97 h1:3RPlVWzZ/PDqmVuf/FKHARG5EMid/tl7cv54Sw/QRVY=
2326
github.com/rogpeppe/go-internal v1.10.1-0.20230524175051-ec119421bb97/go.mod h1:ddIwULY96R17DhadqLgMfk9H9tvdUzkipdSkR5nkCZA=
24-
github.com/rsteube/carapace v0.46.3-0.20231214181515-27e49f3c3b69 h1:ctOUuKn5PO6VtwtaS7unNrm6u20YXESPtnKEie/u304=
25-
github.com/rsteube/carapace v0.46.3-0.20231214181515-27e49f3c3b69/go.mod h1:4ZC5bulItu9t9sZ5yPcHgPREd8rPf274Q732n+wfl/o=
26-
github.com/rsteube/carapace-shlex v0.1.1 h1:fRQEBBKyYKm4TXUabm4tzH904iFWSmXJl3UZhMfQNYU=
27-
github.com/rsteube/carapace-shlex v0.1.1/go.mod h1:zPw1dOFwvLPKStUy9g2BYKanI6bsQMATzDMYQQybo3o=
2827
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
29-
github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho=
3028
github.com/spf13/cobra v1.8.1 h1:e5/vxKd/rZsfSJMUX1agtjeTDf+qv1/JdBF8gg5k9ZM=
3129
github.com/spf13/cobra v1.8.1/go.mod h1:wHxEcudfqmLYa8iTfL+OuZPbBZkmvliBWKIezN3kD9Y=
3230
github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=

0 commit comments

Comments
 (0)