2016-08-22 17:52:14 +02:00
# steamguard-cli
2016-08-28 00:45:26 +02:00
A linux utility for setting up and using Steam Mobile Authenticator (AKA Steam 2FA) on the command line.
**This utility is in beta.**
2016-08-22 17:52:14 +02:00
2021-07-30 05:02:27 +02:00
**We are in the process of rewriting steamguard-cli from scratch in Rust.** Any help would be greatly appreciated! See #55 for discussion. The instructions in this document refer to the C# version.
2016-08-22 17:52:14 +02:00
# Disclaimer
2016-08-28 00:45:26 +02:00
**Use this software at your own risk.**
2016-08-22 17:52:14 +02:00
# 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.
2016-08-23 21:53:11 +02:00
git clone --recursive https://github.com/dyc3/steamguard-cli.git
2016-08-22 17:52:14 +02:00
cd steamguard-cli
make
To run the current build:
2016-08-28 00:45:26 +02:00
build/steamguard
To run the current build quickly:
2016-08-22 17:52:14 +02:00
make run
2020-01-27 22:43:25 +01:00
## macOS
Building on macOS is pretty simple. Make sure you have all the prerequisites listed above.
* For the prerequisites the easiest way to install them is to use [homebrew ](https://brew.sh/ ):
brew update
brew install mono
brew install nuget
* For the application source code:
git clone --recursive https://github.com/dyc3/steamguard-cli.git
cd steamguard-cli
make -f makefile.macos
To run the current build:
mono build/steamguard
To run the current build quickly:
make -f makefile.macos run
To install run:
make -f makefile.macos install
2016-08-22 17:52:14 +02:00
## Windows
Coming soon...
# Installation
2016-08-25 06:18:37 +02:00
To install the latest version on Debian-based systems, download the package from the releases section and type
2016-08-28 00:45:26 +02:00
sudo dpkg --install steamguard-cli_x.x.x.x-x.deb
2021-07-30 05:02:27 +02:00
2017-09-13 22:46:00 +02:00
For Archlinux, install [steamguard-cli-git ](https://aur.archlinux.org/packages/steamguard-cli-git/ ) from the AUR.
2016-08-24 01:56:39 +02:00
To install after building from source, run:
sudo make install
2016-08-22 17:52:14 +02:00
# Usage
2017-05-23 00:26:54 +02:00
`steamguard-cli` looks for your `maFiles` folder in the current user's home directory (eg. `~/maFiles/` ).
2016-10-20 00:10:18 +02:00
Your `maFiles` can be created with [Steam Desktop Authenticator][SDA]. You can create `maFiles` with
2017-05-23 00:26:54 +02:00
steamguard-cli using the `setup` action (`steamguard setup`).
2016-08-22 17:52:14 +02:00
**REMEMBER TO MAKE BACKUPS OF YOUR `maFiles` , AND TO WRITE DOWN YOUR RECOVERY CODE!**
[SDA]: https://github.com/Jessecar96/SteamDesktopAuthenticator
## Arguments
2016-08-28 00:45:26 +02:00
usage: steamguard (action) (steam username) -v -h
-h, --help Display this help message.
-v, --verbose Display some extra information when the program is running.
2016-08-28 01:07:16 +02:00
-m, --mafiles-path Specify which folder your maFiles are in. Ex: ~/maFiles
2017-05-23 00:26:54 +02:00
-p, --passkey Specify your encryption passkey.
2016-08-28 00:45:26 +02:00
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
2017-05-23 00:26:54 +02:00
trade Opens an interactive prompt to handle trade confirmations.
accept-all Accepts all trade confirmations.
