core/go-crypt
8
0
Fork 0
Code Issues 5 Pull requests 1 Projects Releases Packages Wiki Activity Actions

docs: finish AX review follow-ups

Browse source 
Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
Virgil 2026-03-26 11:31:34 +00:00
parent 814ef96624
commit f15fb2b475
4 changed files with 19 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CLAUDE.md
View file

@ -48,7 +48,7 @@ workspace file instead.
| `dappco.re/go/core` | `../go` | Framework: `core.Crypt` interface, `io.Medium` |
| `dappco.re/go/core/log` | `../go-log` | `coreerr.E()` contextual error wrapping |
| `dappco.re/go/core/io` | `../go-io` | `io.Medium` storage abstraction |
| `forge.lthn.ai/core/go-store` | `../go-store` | SQLite KV store (session persistence) |
| `dappco.re/go/core/store` | `../go-store` | SQLite KV store (session persistence) |
| `forge.lthn.ai/core/cli` | `../cli` | CLI framework for `cmd/crypt` commands |
No C toolchain or CGo required — all crypto uses pure Go implementations.

7
cmd/testcmd/cmd_main.go
View file

@ -20,7 +20,7 @@ var (
testCovLowStyle = cli.NewStyle().Foreground(cli.ColourRed500)
)
// Flag variables for test command
// Flag variables for test command.
var (
testVerbose bool
testCoverage bool
@ -31,10 +31,15 @@ var (
testJSON bool
)
// testCmd wraps `go test`, defaulting to `./...` and keeping coverage enabled
// so both human-readable and JSON summaries can report package coverage.
var testCmd = &cli.Command{
Use: "test",
Short: i18n.T("cmd.test.short"),
Long: i18n.T("cmd.test.long"),
Example: ` core test
core test --pkg ./auth --run TestLogin_Good
core test --race --json`,
RunE: func(cmd *cli.Command, args []string) error {
return runTest(testVerbose, testCoverage, testShort, testPkg, testRun, testRace, testJSON)
},

15
docs/development.md
View file

@ -9,8 +9,8 @@ description: How to build, test, and contribute to go-crypt.
- **Go 1.26** or later (the module declares `go 1.26.0`).
- A Go workspace (`go.work`) that resolves the local dependencies:
`forge.lthn.ai/core/go`, `forge.lthn.ai/core/go-store`,
`forge.lthn.ai/core/go-io`, `forge.lthn.ai/core/go-log`, and
`dappco.re/go/core`, `dappco.re/go/core/store`,
`dappco.re/go/core/io`, `dappco.re/go/core/log`, and
`forge.lthn.ai/core/cli`. If you are working outside the full monorepo,
create a `go.work` at the parent directory pointing to your local
checkouts.
@ -211,16 +211,17 @@ HTTPS authentication is not configured for this repository.
## Local Dependencies
The `go.mod` depends on several `forge.lthn.ai/core/*` modules. These are
The `go.mod` depends on several `dappco.re/go/core/*` modules plus the
remaining `forge.lthn.ai/core/cli` dependency. These are
resolved through the Go workspace (`~/Code/go.work`). Do not modify the
replace directives in `go.mod` directly -- use the workspace file instead.
| Module | Local Path | Purpose |
|--------|-----------|---------|
| `forge.lthn.ai/core/go` | `../go` | Framework: `core.Crypt` interface, `io.Medium` |
| `forge.lthn.ai/core/go-store` | `../go-store` | SQLite KV store for session persistence |
| `forge.lthn.ai/core/go-io` | `../go-io` | `io.Medium` storage abstraction |
| `forge.lthn.ai/core/go-log` | `../go-log` | `core.E()` contextual error wrapping |
| `dappco.re/go/core` | `../go` | Framework: `core.Crypt` interface, `io.Medium` |
| `dappco.re/go/core/store` | `../go-store` | SQLite KV store for session persistence |
| `dappco.re/go/core/io` | `../go-io` | `io.Medium` storage abstraction |
| `dappco.re/go/core/log` | `../go-log` | `core.E()` contextual error wrapping |
| `forge.lthn.ai/core/cli` | `../cli` | CLI framework for `cmd/crypt` commands |
## Known Limitations

8
docs/index.md
View file

@ -144,10 +144,10 @@ core crypt checksum myfile.txt --verify "abc123..."
| Module | Role |
|--------|------|
| `forge.lthn.ai/core/go` | Framework: `core.E` error helper, `core.Crypt` interface, `io.Medium` storage abstraction |
| `forge.lthn.ai/core/go-store` | SQLite KV store for persistent session storage |
| `forge.lthn.ai/core/go-io` | `io.Medium` interface used by the auth package |
| `forge.lthn.ai/core/go-log` | Contextual error wrapping via `core.E()` |
| `dappco.re/go/core` | Framework: `core.E` error helper, `core.Crypt` interface, `io.Medium` storage abstraction |
| `dappco.re/go/core/store` | SQLite KV store for persistent session storage |
| `dappco.re/go/core/io` | `io.Medium` interface used by the auth package |
| `dappco.re/go/core/log` | Contextual error wrapping via `core.E()` |
| `forge.lthn.ai/core/cli` | CLI framework for the `cmd/crypt` commands |
| `github.com/ProtonMail/go-crypto` | OpenPGP implementation (actively maintained, post-quantum research) |
| `golang.org/x/crypto` | Argon2id, ChaCha20-Poly1305, scrypt, HKDF, bcrypt |