keybase / keybase/keybase-issues

"Getting started from the command line" examples don't all work on Windows

Open
#698 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
899
Forks
40
PR merge metrics
No merged PRs in 30d

Description

Some of the examples use single quotes which aren't interpreted as meaning a string arguments for Window's Command Prompts:

```
> keybase encrypt mnem -m 'a secret for myself'
usage: keybase encrypt [-h] [-r] [-l] [-a ASSERT] [--batch] [--prompt-remote]
[-s] [-m MESSAGE] [-b] [-o OUTPUT]
them [file]
keybase encrypt: error: Unrecognized arguments: secret for myself'.
```

So here it's passing the string as three arguments: `'secret`, `for` and `myself'`. A solution would be to show the examples using double quotes and then it'll work as expected (although then sane shell users might get some unexpected expansions).

Note that this only affects Command Prompt. PowerShell correctly interprets single quotes for string arguments.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the "Getting started from the command line" examples mentioned in the issue, starting with the `keybase encrypt mnem -m` example. Check the examples in Windows Command Prompt and PowerShell, then update the affected Command Prompt examples so their quoted string arguments work there without breaking the documented PowerShell behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.