Skip to content
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.

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

[CLEANUP] Migration of options to more appropriate sections #2681

Merged
merged 11 commits into from
Nov 3, 2023
Merged
2 changes: 1 addition & 1 deletion .github/workflows/autorelease.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.20'
go-version: '1.21'
- uses: actions/cache@v3
with:
path: ~/go/pkg/mod
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.20'
go-version: '1.21'
- uses: actions/cache@v3
with:
path: ~/go/pkg/mod
Expand Down Expand Up @@ -75,7 +75,7 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.20'
go-version: '1.21'

- run: git config --global user.name nobody
- run: git config --global user.email foo.bar@example.org
Expand All @@ -93,7 +93,7 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.20'
go-version: '1.21'

- run: git config --global user.name nobody
- run: git config --global user.email foo.bar@example.org
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/golangci-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.20'
go-version: '1.21'
- uses: actions/checkout@v4
- name: golangci-lint
uses: golangci/golangci-lint-action@v3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/grype.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.20'
go-version: '1.21'
- uses: actions/cache@v3
with:
path: ~/go/pkg/mod
Expand Down
4 changes: 3 additions & 1 deletion .golangci.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
run:
skip-dirs:
- helpers/
go: 1.20
go: 1.21
deadline: 5m

linters-settings:
gocyclo:
Expand Down Expand Up @@ -46,6 +47,7 @@ linters:
- govet
- interfacer
- ifshort
- inamedparam
- interfacebloat
- ireturn
- lll
Expand Down
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ through gopass as well.
* [ENHANCEMENT] Hide password on MacOS clipboards (#2065)
* [ENHANCEMENT] Passage compat improvements (#2060, #2060)
* [ENHANCEMENT] gopass git invokes git directly (#2102)
* [ENHANCEMENT] Template support for the create wizard (#2064)
* [ENHANCEMENT] Template support for the create wizard (#2064)
* [ENHANCENMENT] Check for MacOS Keychain storing the GPG (#2144)
* [EXPERIMENTAL] Support the Fossil SCM (#2092, #2022)
* [FEATURE] Add env variables for custom clipboard commands. (#2091, #2042)
Expand Down Expand Up @@ -574,13 +574,13 @@ be included in any binary re-distribution of gopass.

## 1.8.4 / 2018-12-26

* [ENHANCEMENT] Evaluate templates when inserting single secrets [#1023]
* [ENHANCEMENT] Add fuzzy search dialog for gopass otp [#1021]
* [ENHANCEMENT] Evaluate templates when inserting single secrets [#1023]
* [ENHANCEMENT] Add fuzzy search dialog for gopass otp [#1021]
* [ENHANCEMENT] Add edit option to search dialog [#1019]
* [ENHANCEMENT] Introduce build tags for experimental features [#1000]
* [BUGFIX] Fix recursive delete [#1024]
* [BUGFIX] Abort tests on critical failures [#997]
* [BUGFIX] Zsh autocompletion [#996]
* [BUGFIX] Zsh autocompletion [#996]

## 1.8.3 / 2018-11-19

Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM golang:1.20-alpine AS build-env
FROM golang:1.21-alpine AS build-env

ENV CGO_ENABLED 0

Expand Down
10 changes: 5 additions & 5 deletions docs/commands/audit.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ $ gopass audit

## Password strength backends

Backend Description
------- | -----------
[`zxcvbn`](https://github.com/nbutton23/zxcvbn) | [zxcvbn](https://github.com/dropbox/zxcvbn) password strength checker.
[`crunchy`](https://github.com/muesli/crunchy) | Crunchy password strength checker
`name` Checks if password equals the name of the secret
| Backend | Description |
|-------------------------------------------------|------------------------------------------------------------------------|
| [`zxcvbn`](https://github.com/nbutton23/zxcvbn) | [zxcvbn](https://github.com/dropbox/zxcvbn) password strength checker. |
| [`crunchy`](https://github.com/muesli/crunchy) | Crunchy password strength checker |
| `name` | Checks if password equals the name of the secret |


8 changes: 4 additions & 4 deletions docs/commands/clone.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ $ gopass clone git@example.com/store.git sub/store

## Flags

Flag Aliases | Description
---- | ------- | -----------
`--path` | | The path to clone the repo to.
`--crypto` | Override the crypto backend to use if the auto-detection fails.
| Flag | Aliases | Description |
|------------|---------|-----------------------------------------------------------------|
| `--path` | | The path to clone the repo to. |
| `--crypto` | | Override the crypto backend to use if the auto-detection fails. |
10 changes: 5 additions & 5 deletions docs/commands/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ Note: To manage mounts use `gopass mounts`.

```bash
gopass config
gopass config core.autoclip
gopass config core.autoclip false
gopass config generate.autoclip
gopass config generate.autoclip false
```

## Flags

Flag Description
---- | -----------
`--store` | Only sync a specific sub store
| Flag | Description |
|-----------|--------------------------------|
| `--store` | Only sync a specific sub store |
10 changes: 5 additions & 5 deletions docs/commands/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ attributes:

## Flags

Flag Aliases | Description
---- | ------- | -----------
`--store` | `-s` | Select the store to use. Will be used to look up user templates.
`--force` | `-f` | For overwriting existing entries.
`--print` | `-p` | Print the password to STDOUT.
| Flag | Aliases | Description |
|-----------|---------|------------------------------------------------------------------|
| `--store` | `-s` | Select the store to use. Will be used to look up user templates. |
| `--force` | `-f` | For overwriting existing entries. |
| `--print` | `-p` | Print the password to STDOUT. |
8 changes: 4 additions & 4 deletions docs/commands/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ $ gopass delete entry key

## Flags

Flag Aliases | Description
---- | ------- | -----------
`--recursive` | `-r` | Recursively delete files and folders.
`--force` | `-f` Do not ask for confirmation.
| Flag | Aliases | Description |
|---------------|---------|---------------------------------------|
| `--recursive` | `-r` | Recursively delete files and folders. |
| `--force` | `-f` | Do not ask for confirmation. |

## Details

Expand Down
8 changes: 4 additions & 4 deletions docs/commands/edit.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ $ EDITOR=/bin/nano gopass edit entry

## Flags

Flag Aliases | Description
---- | ------- | -----------
`--editor` | `-e` | Specify the path to an editor. Must accept the filename as it's first argument.
`--create` | `-c` | Create a new secret. You can create a new secret with `edit` with or without `-c`, but `-c` will skip searching for existing matches.
| Flag | Aliases | Description |
|------------|---------|---------------------------------------------------------------------------------------------------------------------------------------|
| `--editor` | `-e` | Specify the path to an editor. Must accept the filename as it's first argument. |
| `--create` | `-c` | Create a new secret. You can create a new secret with `edit` with or without `-c`, but `-c` will skip searching for existing matches. |
8 changes: 4 additions & 4 deletions docs/commands/find.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ $ gopass find -c entry

## Flags

Flag | Aliases | Description
---- | ------- | -----------
`--clip` | `-c` | Copy the password into the clipboard.
`--unsafe` | `-u` | Display any unsafe content, even if `safecontent` is enabled.
| Flag | Aliases | Description |
|------------|---------|---------------------------------------------------------------|
| `--clip` | `-c` | Copy the password into the clipboard. |
| `--unsafe` | `-u` | Display any unsafe content, even if `safecontent` is enabled. |

34 changes: 17 additions & 17 deletions docs/commands/generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,28 +20,28 @@ $ gopass generate entry key [length]

## Flags

Flag | Aliases | Description
---- | ------- | -----------
`--clip` | `-c` | Copy the generated password into the clipboard. Default: Value of `autoclip`
`--print` | `-p` | Print the generated password to the terminal. Default: false.
`--force` | `-f` | Force overwriting an existing entry.
`--edit` | `-e` | Generate a password and open the entry for editing in `$EDITOR`.
`--generator` | `-g` | Choose of of the available password generators, desribed below. Default: `cryptic`
`--symbols` | `-s` | Include symbols in the generated password (default: `false`)
`--strict` | | Ensure each requested character class is actually included. Without this option all requested classes can be included, but not necessarily are. (default: `false`)
`--sep` | | Word separator for multi-word generators.
`--lang`| | Language for word-based generators.
| Flag | Aliases | Description |
|---------------|---------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `--clip` | `-c` | Copy the generated password into the clipboard. Default: Value of `autoclip` |
| `--print` | `-p` | Print the generated password to the terminal. Default: false. |
| `--force` | `-f` | Force overwriting an existing entry. |
| `--edit` | `-e` | Generate a password and open the entry for editing in `$EDITOR`. |
| `--generator` | `-g` | Choose of of the available password generators, desribed below. Default: `cryptic` |
| `--symbols` | `-s` | Include symbols in the generated password (default: `false`) |
| `--strict` | | Ensure each requested character class is actually included. Without this option all requested classes can be included, but not necessarily are. (default: `false`) |
| `--sep` | | Word separator for multi-word generators. |
| `--lang` | | Language for word-based generators. |

## Password Generators

Use `--generator` to select one of the available password generators:

Generator | Description
--------- | -----------
`cryptic` | The default generator yields cryptic passwords that should work with most sites. Use `--symbols` and `--strict` if the site has specific requirements. Please note that we auto-detect the correct rules for some sites. The length argument specifies the number of characters.
`xkcd` | Use an [XKCD#936](https://xkcd.com/936/) style password. Use `--lang` and `--sep` to refine it's behaviour. The length argument specifies the number of words.
`memorable` | Generate a memorable password. The length argument specifies the minimum lenght of characters. Please note that the password might be longer if not all necessary rules were satisfied by the minimum length solution.
`external` | Use the external generator from `$GOPASS_EXTERNAL_PWGEN`
| Generator | Description |
|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `cryptic` | The default generator yields cryptic passwords that should work with most sites. Use `--symbols` and `--strict` if the site has specific requirements. Please note that we auto-detect the correct rules for some sites. The length argument specifies the number of characters. |
| `xkcd` | Use an [XKCD#936](https://xkcd.com/936/) style password. Use `--lang` and `--sep` to refine it's behaviour. The length argument specifies the number of words. |
| `memorable` | Generate a memorable password. The length argument specifies the minimum lenght of characters. Please note that the password might be longer if not all necessary rules were satisfied by the minimum length solution. |
| `external` | Use the external generator from `$GOPASS_EXTERNAL_PWGEN` |

## Relevant configuration options

Expand Down
10 changes: 5 additions & 5 deletions docs/commands/gopass.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ $ gopass -c entry

Note: DO NOT use in scripts! Use `gopass show` instead.

Flag Aliases | Description
---- | ------- | -----------
`--clip` | `-c` | Copy the password value into the clipboard and don't show the content.
`--unsafe` | `-u` | Display unsafe content (e.g. the password) even when the `safecontent` option is set. No-op when `safecontent` is `false`.
`--yes` | | Assume yes on all yes/no questions or use the default on all others.
| Flag | Aliases | Description |
|------------|---------|----------------------------------------------------------------------------------------------------------------------------|
| `--clip` | `-c` | Copy the password value into the clipboard and don't show the content. |
| `--unsafe` | `-u` | Display unsafe content (e.g. the password) even when the `safecontent` option is set. No-op when `safecontent` is `false`. |
| `--yes` | | Assume yes on all yes/no questions or use the default on all others. |

12 changes: 6 additions & 6 deletions docs/commands/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ $ gopass init --crypto [age|gpg] --storage=[fs|gitfs]

## Flags

Flag Aliases | Description
---- | ------- | -----------
`--path` | `-p` | Initialize the (sub) store in this location.
`--store` | `-s` | Mount the newly initialized sub-store at this mount point
`--crypto` | | Select the crypto backend. Choose one of: `gpgcli`, `age`, `xc` (deprecated) or `plain`. Default: `gpgcli`
`--storage` | | Select the storage and RCS backend. Choose one of: `gitfs`, `fs`. Default: `gitfs`
| Flag | Aliases | Description |
|-------------|---------|-------------------------------------------------------------------------------------------------------------|
| `--path` | `-p` | Initialize the (sub) store in this location. |
| `--store` | `-s` | Mount the newly initialized sub-store at this mount point |
| `--crypto` | | Select the crypto backend. Choose one of: `gpgcli`, `age`, `xc` (deprecated) or `plain`. Default: `gpgcli` |
| `--storage` | | Select the storage and RCS backend. Choose one of: `gitfs`, `fs`. Default: `gitfs` |

See [backends.md](../backends.md) for more information on the available backends.
12 changes: 6 additions & 6 deletions docs/commands/insert.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Note: `insert` will not change anything but the `Password` field (using the `ins

## Flags

Flag | Aliases | Description
---- | ------- | -----------
`--echo` | `-e` | Display the secret while typing (default: `false`)
`--multiline` | `-m` | Insert using `$EDITOR` (default: `false`). This identical to running `gopass edit entry`. All other flags are ignored.
`--force` `-f` | Overwrite any existing value and do not prompt. (default: `false`)
`--append` | `-a` | Append to any existing data. Only applies if reading from STDIN. (default: `false`)
| Flag | Aliases | Description |
|---------------|---------|------------------------------------------------------------------------------------------------------------------------|
| `--echo` | `-e` | Display the secret while typing (default: `false`) |
| `--multiline` | `-m` | Insert using `$EDITOR` (default: `false`). This identical to running `gopass edit entry`. All other flags are ignored. |
| `--force` | `-f` | Overwrite any existing value and do not prompt. (default: `false`) |
| `--append` | `-a` | Append to any existing data. Only applies if reading from STDIN. (default: `false`) |
12 changes: 6 additions & 6 deletions docs/commands/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ Note: `list` will not change anything, nor encrypt or decrypt anything.

## Flags

Flag | Aliases Description
---- | ------- | -----------
`--limit value` | `-l value`| Max tree depth (default: -1)
`--flat` |`-f` | Print a flat list of secrets (default: false)
`--folders` | `-d` | Print a flat list of folders (default: false)
`--strip-prefix` | `-s` | Strip prefix from filtered entries (default: false)
| Flag | Aliases | Description |
|------------------|------------|-----------------------------------------------------|
| `--limit value` | `-l value` | Max tree depth (default: -1) |
| `--flat` | `-f` | Print a flat list of secrets (default: false) |
| `--folders` | `-d` | Print a flat list of folders (default: false) |
| `--strip-prefix` | `-s` | Strip prefix from filtered entries (default: false) |

The `--flat` and `--folders` flags provide a plaintext list of the entries located at
the given prefix (default prefix being the root `/`). They are notably used to produce the
Expand Down
6 changes: 3 additions & 3 deletions docs/commands/move.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ $ gopass move entry entry

## Flags

Flag | Aliases | Description
---- | ------- | -----------
`--force` | `-f` | Overwrite existing destination without asking.
| Flag | Aliases | Description |
|-----------|---------|------------------------------------------------|
| `--force` | `-f` | Overwrite existing destination without asking. |

## Details

Expand Down
6 changes: 3 additions & 3 deletions docs/commands/sync.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,6 @@ Note: `gopass sync` only supports one remote per store.

## Flags

Flag Description
---- | -----------
`--store` | Only sync a specific sub store
| Flag | Description |
|-----------|--------------------------------|
| `--store` | Only sync a specific sub store |
Loading