Docs for firmware 3.1.0: user input modes, web derive mode, CLI additions, retired quick setup / plausible deniability / Travel Edition - #5
Open
0c-coder wants to merge 7 commits into
Conversation
…ions, retired quick setup / plausible deniability / Travel Edition - command-line: `capabilities`; `storedkeymode`/`derivedkeymode` now 0/1/2 with Button Press as the default and config mode required; new `webderivemode`; `2ndprofilemode` only accepts 1; `sysadminmode`/`lockbutton` descriptions were copy-pasted from the challenge-mode entries and are corrected; `setkey`/`genkey` gain `c` (X25519 - `x` was documented as X25519 but is Ed25519), `m`, `w`. - usersguide / duousersguide: the three user input modes described once with the new default, plus the Web Derived Key User Input Mode section; quick setup section replaced by a note that it was removed; button definitions for an unconfigured device updated. - onlykey-agent: button-press default, GPG notes, `--skey derived-v2` (HKDF derivation added alongside the released one). - ite / pdguide: rewritten as retirement notices. pdguide documents the automatic migration of an existing plausible deniability profile (first primary-PIN unlock converts it; second PIN does not unlock until then) and the removal of legacy support in the following release. features / index / faq / webcrypt updated to match. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0159zPxi7DCuucC1ZcqYBB8W
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0159zPxi7DCuucC1ZcqYBB8W
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0159zPxi7DCuucC1ZcqYBB8W
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0159zPxi7DCuucC1ZcqYBB8W
Quick setup no longer exists, so the docs no longer describe it, not even as removed. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0159zPxi7DCuucC1ZcqYBB8W
Remove /ite from the sidebar and the guide index, and trim the features note to plausible deniability only. The ite page stays as a retirement notice for people who reach it by its old URL. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0159zPxi7DCuucC1ZcqYBB8W
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0159zPxi7DCuucC1ZcqYBB8W
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation for the firmware/CLI/App changes on the
feat/user-input-modesbranches (librariesee95f16, OnlyKey-Firmware8306772, python-onlykeyff44b79, lib-agent237692c, OnlyKey-Appf9ddf08). Written to be merged together with those; the version is referred to as 3.1.0 throughout.What changed and where
command-linecapabilities;storedkeymode/derivedkeymodeare 0 challenge / 1 button press (default) / 2 no press (dev firmware only), config mode required; newwebderivemode;2ndprofilemodeonly accepts 1;sysadminmodeandlockbuttonhad copy-pasted challenge-mode text — corrected;setkey/genkeyaddc(X25519 —xwas documented as X25519 but is Ed25519),m(ML-KEM-768),w(X-Wing)usersguide,duousersguide#web-derive-mode); quick setup section replaced by a removal note; unconfigured-device button definitionsonlykey-agent--skey derived-v2, HKDF derivation added alongside the released one)itepdguidefeatures,index,faq,webcryptSlugs and anchors are unchanged so existing links (
/ite,/pdguide,#derived-challenge-mode,#stored-challenge-mode,#quick-setup) still resolve.Not covered (needs a decision first)
usersguide/appthat show the "Plausible Deniability Profile" radio in the setup wizard.age-plugin-onlykey/ onlyagent.app page — the web derive mode section links to onlyagent.app but there is no page for the derived X-Wing age workflow yet.🤖 Generated with Claude Code
https://claude.ai/code/session_0159zPxi7DCuucC1ZcqYBB8W