No description

Find a file

Carson McManus a94d224282 fix #15 , thanks @bontibon		2017-06-04 15:00:03 -04:00
SteamAuth@825a749f09	Added SteamAuth as a git submodule	2016-08-21 11:58:39 -04:00
.gitignore	updated .gitignore for SteamAuth/SteamAuth/packages/	2016-08-23 11:49:58 -04:00
.gitmodules	Added SteamAuth as a git submodule	2016-08-21 11:58:39 -04:00
AssemblyInfo.cs	add github link to metadata	2017-05-22 18:34:57 -04:00
bash-tab-completion	add --passkey to bash tab completion	2017-05-22 18:34:56 -04:00
makefile	add Utils.cs to makefile	2017-05-22 18:34:56 -04:00
Manifest.cs	implement ReadLineSecure(), fix #7	2017-05-22 17:45:49 -04:00
package.sh	add mono-complete dependency to package building	2017-05-22 18:44:58 -04:00
Program.cs	fix #15 , thanks @bontibon	2017-06-04 15:00:03 -04:00
README.md	update README.md with new help text	2017-05-22 18:34:57 -04:00
steamguard-cli.csproj	Added --trade to list all trade confirmations	2016-08-25 22:21:12 -04:00
steamguard-cli.sln	added .csproj and .sln files	2016-08-23 11:40:51 -04:00
Utils.cs	add Utils class and Utils.ReadLineSecure()	2017-05-22 17:35:55 -04:00

README.md

steamguard-cli

A linux utility for setting up and using Steam Mobile Authenticator (AKA Steam 2FA) on the command line. This utility is in beta.

Disclaimer

Use this software at your own risk.

Prerequisites

These packages are required to build and run steamguard-cli.

mono-complete
nuget
make

Building

Downloading as .zip will not work because submodules are used. You must clone the repository.

Linux

Building on Linux is very simple. Make sure you have all the prerequisites listed above.

git clone --recursive https://github.com/dyc3/steamguard-cli.git
cd steamguard-cli
make

To run the current build:

build/steamguard

To run the current build quickly:

make run

Windows

Coming soon...

Installation

To install the latest version on Debian-based systems, download the package from the releases section and type

sudo dpkg --install steamguard-cli_x.x.x.x-x.deb

To install after building from source, run:

sudo make install

Usage

steamguard-cli looks for your maFiles folder in the current user's home directory (eg. ~/maFiles/). Your maFiles can be created with Steam Desktop Authenticator. You can create maFiles with steamguard-cli using the setup action (steamguard setup).

REMEMBER TO MAKE BACKUPS OF YOUR maFiles, AND TO WRITE DOWN YOUR RECOVERY CODE!

Arguments

usage: steamguard (action) (steam username) -v -h

  -h, --help                Display this help message.
  -v, --verbose             Display some extra information when the program is running.
  -m, --mafiles-path        Specify which folder your maFiles are in. Ex: ~/maFiles
  -p, --passkey             Specify your encryption passkey.

Actions:
  generate-code             Generate a Steam Guard code for the specified user (if any) and exit. (default)
  encrypt                   Encrypt your maFiles or change your encryption passkey.
  decrypt                   Remove encryption from your maFiles.
  code                      Same as generate-code
  2fa                       Same as generate-code
  add                       Set up Steam Guard for 2 factor authentication.
  setup                     Same as add
  trade                     Opens an interactive prompt to handle trade confirmations.
  accept-all                Accepts all trade confirmations.