simono41/steamguard-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
Carson McManus 2021-08-25 00:40:07 -04:00
parent 5a004efd06
commit feac39ae0a
1 changed files with 17 additions and 83 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

100
README.md
View file

@ -1,77 +1,25 @@
# 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.**
A command line utility for setting up and using Steam Mobile Authenticator (AKA Steam 2FA). It can also be used to respond to trade and market confirmations.
**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.
**The only legitamate place to download steamguard-cli binaries is through this repo's releases, or by any package manager that is linked in this document.**
# Disclaimer
**Use this software at your own risk.**
**This utility is effectively in beta. Use this software at your own risk. Make sure to back up your maFiles regularly, and make sure to actually write down your revocation code. If you lose both of these, we can't help you, your only recourse is to beg Steam support.**
# Prerequisites
These packages are required to build and run steamguard-cli.
* mono-complete
* nuget
* make
# Install
# Building
Downloading as .zip will not work because submodules are used. You must clone the repository.
If you have the Rust toolchain installed:
```
cargo install steamguard-cli
```
## Linux
Building on Linux is very simple. Make sure you have all the prerequisites listed above.
Otherwise, you can download binaries from the releases.
git clone --recursive https://github.com/dyc3/steamguard-cli.git
cd steamguard-cli
make
## Building From Source
To run the current build:
build/steamguard
To run the current build quickly:
make run
## 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
## 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
For Archlinux, install [steamguard-cli-git](https://aur.archlinux.org/packages/steamguard-cli-git/) from the AUR.
To install after building from source, run:
sudo make install
```
cargo build --release
```
# Usage
`steamguard-cli` looks for your `maFiles` folder in the current user's home directory (eg. `~/maFiles/`).
@ -82,21 +30,7 @@ steamguard-cli using the `setup` action (`steamguard setup`).
[SDA]: https://github.com/Jessecar96/SteamDesktopAuthenticator
## 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.
Full helptext can be displayed with:
```
steamguard --help
```