feat: `new` command by shikaan · Pull Request #47 · shikaan/keydex

shikaan · 2026-03-11T07:28:53Z

This change adds a new/create command to create an empty database.

Closes #34

TODO

Add short and long descriptions of the command
Coalesce gokeepasslib calls into one kdbx call
Use the unified call in tests too
Support key file flows as well
Generate documentation

This implementation currently does not allow creating an archive with a keyfile just yet.

Copilot

Pull request overview

Adds a new create/new CLI command to create an empty KeePass (.kdbx) database, and refactors database initialization/opening so tests and commands use a unified kdbx API.

Changes:

Introduce create/new command with interactive passphrase creation and optional immediate TUI open.
Refactor pkg/kdbx to use OpenFromPath + NewFromFile and centralize credential setup via SetPasswordAndKey.
Update CLI/TUI tests and improve error message clarity across several packages.

Reviewed changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
tui/app.go	Tweaks TUI startup error message formatting.
test/tui_test.go	Updates E2E TUI fixture creation to use `pkg/kdbx` APIs.
test/cli_test.go	Updates fixture DB creation; adds help/arg-validation tests for `create/new`.
pkg/log/log.go	Adjusts error messages during log initialization.
pkg/kdbx/kdbx_test.go	Updates tests for `Database.file` pointer change.
pkg/kdbx/kdbx.go	Adds `OpenFromPath`/`NewFromFile`, credential helper, and updates save/unlock internals.
pkg/credentials/credentials.go	Adds `MakePassphrase` and moves secret reading to `pkg/cli`.
pkg/clipboard/clipboard.go	Improves clipboard error message.
pkg/cli/cli.go	Adds shared CLI helpers for secret input and confirmations.
main.go	Corrects error namespace for unexpected errors.
cmd/root.go	Registers new `Create` command.
cmd/open.go	Switches to `OpenFromPath` and improves error messages.
cmd/list.go	Switches to `OpenFromPath`.
cmd/create.go	New `create/new` command implementation.
cmd/copy.go	Switches to `OpenFromPath` and improves error messages.
CONTRIBUTING.md	Adds manual test checklist for create/new flow.
.vimspector.json	Adds a Vimspector debug configuration.

Comments suppressed due to low confidence (2)

pkg/kdbx/kdbx.go:50

OpenFromPath opens the file and, if UnlockWithPasswordAndKey returns an error (wrong password/key, decode error, etc.), returns without closing the file descriptor. Consider ensuring the file is closed on all error paths (e.g., close before returning on unlock failure).

func OpenFromPath(filepath, password, keypath string) (*Database, error) {
	file, err := os.Open(filepath)

	if err != nil {
		return nil, errors.MakeError("Cannot open "+filepath+": "+err.Error(), "kdbx")
	}

	kdbx, err := NewFromFile(file)
	if err != nil {
		return nil, errors.MakeError("Cannot open "+filepath+": "+err.Error(), "kdbx")
	}

	if err := kdbx.UnlockWithPasswordAndKey(password, keypath); err != nil {
		return nil, err
	}

pkg/kdbx/kdbx.go:353

unlock() calls d.Database.UnlockProtectedEntries() but ignores its returned error. Since UnlockProtectedEntries can fail (and is checked elsewhere in SaveAndUnlockEntries), errors here would be silently ignored and could leave protected values locked. Consider capturing and returning the error.

	if err := gokeepasslib.NewDecoder(d.file).Decode(&d.Database); err != nil {
		return errors.MakeError("Cannot unlock database: "+err.Error(), "kdbx")
	}

	d.Database.UnlockProtectedEntries()
	return nil

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

cmd/create.go

CONTRIBUTING.md

cmd/create.go

pkg/log/log.go

pkg/cli/cli.go

pkg/kdbx/kdbx.go

cmd/create.go

.vimspector.json

In previous implementation, we were accidentally acting on a copy of the entry - which updated the UI, but did not update the archive.

Copilot

Pull request overview

Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (1)

pkg/kdbx/kdbx.go:49

OpenFromPath() opens the file with os.Open, but on error paths after that (e.g., unlock failure), the file handle is never closed. This can leak descriptors and may keep the file locked on some platforms. Consider closing file if NewFromFile or UnlockWithPasswordAndKey returns an error (or have Database take ownership only on success).

	file, err := os.Open(filepath)

	if err != nil {
		return nil, errors.MakeError("Cannot open "+filepath+": "+err.Error(), "kdbx")
	}

	kdbx, err := NewFromFile(file)
	if err != nil {
		return nil, errors.MakeError("Cannot open "+filepath+": "+err.Error(), "kdbx")
	}

	if err := kdbx.UnlockWithPasswordAndKey(password, keypath); err != nil {
		return nil, err
	}

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

pkg/kdbx/kdbx.go

cmd/create.go

Copilot

Pull request overview

Copilot reviewed 19 out of 19 changed files in this pull request and generated 9 comments.

Comments suppressed due to low confidence (1)

pkg/kdbx/kdbx.go:49

OpenFromPath opens a file handle but does not close it if UnlockWithPasswordAndKey fails (e.g., wrong password / decode error). This can leak file descriptors in repeated opens; consider closing file on error (or adding a defer that closes unless ownership is transferred successfully).

func OpenFromPath(filepath, password, keypath string) (*Database, error) {
	file, err := os.Open(filepath)

	if err != nil {
		return nil, errors.MakeError("Cannot open "+filepath+": "+err.Error(), "kdbx")
	}

	kdbx, err := NewFromFile(file)
	if err != nil {
		return nil, errors.MakeError("Cannot open "+filepath+": "+err.Error(), "kdbx")
	}

	if err := kdbx.UnlockWithPasswordAndKey(password, keypath); err != nil {
		return nil, err
	}

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

test/cli_test.go

cmd/create.go

pkg/log/log.go

test/tui_test.go

pkg/kdbx/kdbx_test.go

cmd/create.go

pkg/credentials/credentials.go

shikaan force-pushed the feat/34-new-command branch from 16b997d to 47f9e2f Compare March 11, 2026 07:44

shikaan added 4 commits March 11, 2026 20:31

feat: add create archive command

23f0bbf

This implementation currently does not allow creating an archive with a keyfile just yet.

refactor: normalize capitalization and formating of all error messages

5700875

docs: document the create command in CLI

7a4fc35

test: use gokeepass entry in tests

94e0bdd

shikaan force-pushed the feat/34-new-command branch from 822fc4f to 94e0bdd Compare March 11, 2026 19:42

shikaan added 3 commits March 11, 2026 20:48

fix: add database name to the created database

ff47520

refactor: move empty passphrase check in credentials

7da775d

tests: add CLI tests for the new command

fde81a4

shikaan requested a review from Copilot March 11, 2026 21:53

Copilot started reviewing on behalf of shikaan March 11, 2026 21:53 View session

Copilot AI reviewed Mar 11, 2026

View reviewed changes

shikaan added 9 commits March 12, 2026 18:47

test: automate password prompting tests

4039db3

fix: ensure files are closed on save

164b71f

docs: typos in CONTRIBUTING.md

90ba6de

refactor: use in-memory db instead of reopening

3cfd02b

fix: update modification time upon save

1104d63

In previous implementation, we were accidentally acting on a copy of the entry - which updated the UI, but did not update the archive.

fix: use pointers into entry slices instead of copies

88bade7

fix: print errors on stdout when they occur before settuing up logging

4a9c023

fix: break if we cannot read stdin

253977d

chore: remove vimspector

6de8be0

shikaan requested a review from Copilot March 12, 2026 19:54

Copilot started reviewing on behalf of shikaan March 12, 2026 19:55 View session

Copilot AI reviewed Mar 12, 2026

View reviewed changes

pkg/kdbx/kdbx.go Outdated Show resolved Hide resolved

cmd/create.go Show resolved Hide resolved

shikaan added 2 commits March 12, 2026 21:20

fix: cleanup file handles in create functions

b4efd42

feat: allow creating archive with keyfile

db60e96

shikaan marked this pull request as ready for review March 12, 2026 20:51

shikaan requested a review from Copilot March 12, 2026 20:51

Copilot started reviewing on behalf of shikaan March 12, 2026 20:52 View session

Copilot AI reviewed Mar 12, 2026

View reviewed changes

shikaan added 4 commits March 13, 2026 08:50

fix: check if home is accessible before using it

5e40553

fix: prevent overwriting existing keyfiles

a51987f

docs: regenerate documentation

a57b3d6

chore: prevent stale documentation on main

bdb01a3

shikaan merged commit 7bfea5f into main Mar 13, 2026
1 check passed

shikaan deleted the feat/34-new-command branch March 13, 2026 18:02

Conversation

shikaan commented Mar 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

shikaan commented Mar 11, 2026 •

edited

Loading