From f080e3597149a2c7287205946529f9f7b9bff224 Mon Sep 17 00:00:00 2001 From: Carson McManus Date: Sat, 24 Jun 2023 09:47:25 -0400 Subject: [PATCH] add quickstart document (#216) --- README.md | 4 ++++ docs/quickstart.md | 55 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 docs/quickstart.md diff --git a/README.md b/README.md index 33bce26..f146f3b 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,10 @@ A command line utility for setting up and using Steam Mobile Authenticator (AKA # Disclaimer **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.** +# Quickstart + +If you have no idea what the rest of this document is talking about, go read the [quickstart](docs/quickstart.md). + # Install If you have the Rust toolchain installed: diff --git a/docs/quickstart.md b/docs/quickstart.md new file mode 100644 index 0000000..b5738bb --- /dev/null +++ b/docs/quickstart.md @@ -0,0 +1,55 @@ +# Quickstart + +steamguard-cli is a command-line tool, and as such, it is meant to be used in a terminal. This guide will show you how to get started with steamguard-cli. + +## Windows + +1. Download `steamguard.exe` from the [releases page](releases). +2. Place `steamguard.exe` in a folder of your choice. For this example, we will use `%USERPROFILE%\Desktop`. +3. Open Powershell or Command Prompt. The prompt should be at `%USERPROFILE%` (eg. `C:\Users\`). +4. Use `cd` to change directory into the folder where you placed `steamguard.exe`. For this example, it would be `cd Desktop`. +5. You should now be able to run `steamguard.exe` by typing `.\steamguard.exe --help` and pressing enter. + +## Linux + +### Ubuntu/Debian + +1. Download the `.deb` from the [releases page](releases). +2. Open a terminal and run this to install it: +```bash +sudo dpkg -i ./steamguard-cli__amd64.deb +``` + +### Other Linux + +1. Download `steamguard` from the [releases page](releases) +2. Make it executable, and move `steamguard` to `/usr/local/bin` or any other directory in your `$PATH`. +```bash +chmod +x ./steamguard +sudo mv ./steamguard /usr/local/bin +``` +3. You should now be able to run `steamguard` by typing `steamguard --help` and pressing enter. + +# Importing existing maFiles from Steam Desktop Authenticator + +If you have used [Steam Desktop Authenticator][SDA] before, you can use your existing maFiles into steamguard-cli, and they will be automatically upgraded for use with steamguard-cli. + +1. Make a backup of your `maFiles` folder. +2. Place your `maFiles` folder in the following directory: + - Linux: + - `~/.config/steamguard-cli/maFiles/` + - Windows: + - `%APPDATA%\Roaming\steamguard-cli\maFiles\` +3. Run `steamguard` from your terminal. + + +### Importing individual maFiles from Steam Desktop Authenticator + +It's also possible to import a single maFile from Steam Desktop Authenticator and add it to your existing manifest. + +```bash +steamguard import --sda +``` + +[SDA]: https://github.com/Jessecar96/SteamDesktopAuthenticator +[releases]: http://github.com/dyc3/steamguard-cli/releases