keybase / keybase/client

OSX Command line help needs update

Open
#5,394 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
9.2k
Forks
1.3k
Avg merge
12h 58m
Merged PRs (30d)
56

Description

Ryans-MBP:bhcweb ryan$ keybase
NAME:
   keybase - Keybase command line client.

USAGE:
   keybase [global options] command [command options] [arguments...]
   
VERSION:
   1.0.18-20161219185928+7868d49
   
COMMANDS:
   base62		base62 operations
   cert			Print the CA cert for api.keybase.io
   ctl			Control the background keybase service
   currency		Manage cryptocurrency addresses
   decrypt		Decrypt messages or files for keybase users
   deprovision		Revoke the current device, log out, and delete local state.
   device		Manage your devices
   dump-keyfamily	Print out a user's current key family
   encrypt		Encrypt messages or files for keybase users
   follow, track	Verify a user's authenticity and optionally follow them
   fuse			Manage fuse
   id			Identify a user and check their signature chain
   install		Installs Keybase components
   launchd		Manage launchd
   list-followers	List those who follow you
   list-following	List who you or the given user is following
   log			Manage keybase logs
   login		Establish a session with the keybase server
   logout		Logout and remove session information
   paperkey		Generate paper keys for recovering your account
   passphrase		Change or recover your keybase passphrase
   pgp			Manage keybase PGP keys
   ping			Ping the keybase API server
   prove		Generate a new proof
   rekey		Rekey status and actions
   search		Search for keybase users
   sign			Sign a document
   signup		Signup for a new account
   sigs			Manage signatures
   status		Show information about current user
   unfollow, untrack	Unfollow a user
   uninstall		Uninstalls Keybase components
   update		The updater
   verify		Verify message or file signatures for keybase users
   version		Print out version and build information
   help, h		Shows a list of commands or help for one command

ADDITIONAL HELP TOPICS:
   advanced		Description of advanced global options
   gpg			Description of how keybase interacts with GPG
   keyring		Description of how keybase stores secret keys locally
   tor			Description of how keybase works with Tor
   
Ryans-MBP:bhcweb ryan$ keybase update
NAME:
   keybase update - The updater

USAGE:
   keybase update <command> [arguments...]

COMMANDS:
   check	Trigger an update check
   run		Run the updater with custom options
   check-in-use	Check if we are in use (safe for restart)
   notify	Notify the service about an update event
   
Ryans-MBP:bhcweb ryan$ keybase update check
This is no longer supported. Instead you can run:

	/Applications/Keybase.app/Contents/SharedSupport/bin/updater check
Ryans-MBP:bhcweb ryan$ /Applications/Keybase.app/Contents/SharedSupport/bin/updater check
2017/01/13 15:21:53 DEBG Using default path to keybase: /Applications/Keybase.app/Contents/SharedSupport/bin/keybase
2017/01/13 15:21:53 DEBG Execute: /Applications/Keybase.app/Contents/SharedSupport/bin/keybase [version -S]
2017/01/13 15:21:53 DEBG Executed /Applications/Keybase.app/Contents/SharedSupport/bin/keybase [version -S]
2017/01/13 15:21:53 DEBG Execute: /usr/bin/sw_vers [-productVersion]
2017/01/13 15:21:53 DEBG Executed /usr/bin/sw_vers [-productVersion]
2017/01/13 15:21:53 INFO Checking for update, current version is 1.0.18-20161219185928+7868d49
2017/01/13 15:21:53 INFO Using updater source: Keybase.io
2017/01/13 15:21:53 DEBG Using options: updater.UpdateOptions{Version:"1.0.18-20161219185928+7868d49", Platform:"darwin", DestinationPath:"/Applications/Keybase.app", URL:"", Channel:"", Env:"prod", Arch:"amd64", Force:false, OSVersion:"10.12.2", UpdaterVersion:"0.2.7"}
2017/01/13 15:21:53 INFO Request "https://api.keybase.io/_/api/1.0/pkg/update.json?auto_update=1&install_id=ce9bd08e397190271d627ab4215a22c16d81c91905bef41d&os_version=10.12.2&platform=darwin&run_mode=prod&upd_version=0.2.7&version=1.0.18-20161219185928%2B7868d49"
2017/01/13 15:21:53 DEBG Received update response: updater.Update{Version:"1.0.18-20161219185928+7868d49", Name:"v1.0.18-20161219185928+7868d49", Description:"Recent changes:\n---------------\n- Folders view! You can browse your public and private folders and see new sharing requests inside the app.\n\n- Search from the app! Want to share data in KBFS with a Twitter user? Just click the Twitter bird and type their username. This will popup a folder for you, and if they're not on Keybase yet, and invitation code to share.\n\n- Support for macOS 10.12 (Sierra).\n\n- Introducing the main GUI screen. This is where you'll look people up, manage your folders, and perform other actions. A lot of the features are stubbed out, but you can start playing with it.\n\n- Sharing before signup! Go ahead and put data in /keybase/private/you,friend@twitter/. If you have any invite codes, this will pop up a window with a link to DM them. It also works for end-to-end encryption with Reddit, Coinbase, Github, and Hacker News users.\n\nSmall stuff:\n------------\n- Various bug fixes and improvements\n\nWhat we are currently working on:\n---------------------------------\n- KBFS performance, including delayed writes\n- profile editing and proof generation inside the GUI\n", InstallID:"ce9bd08e397190271d627ab4215a22c16d81c91905bef41d", RequestID:"", Type:0, PublishedAt:1482173968000, Props:[]updater.Property(nil), Asset:(*updater.Asset)(0xc42017c820), NeedUpdate:false}

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the reported output with keybase and keybase update check on macOS, then trace the command help and updater entry points that produce it. Done means the displayed help and update guidance no longer advertise the unsupported command and accurately direct users to the supported updater.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, macos
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.