Skip to content

Commit 8630e81

Browse files
committed
docs: clarify cross-platform CLI fork
1 parent 7d20fbd commit 8630e81

1 file changed

Lines changed: 36 additions & 1 deletion

File tree

README.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,39 @@
1-
# Windows Authenticator
1+
# winauth-running-on-all-OS.cli
2+
3+
Cross-platform command-line WinAuth fork for running exported authenticator secrets on Linux,
4+
macOS, and Windows through Mono, without the original Windows GUI.
5+
6+
The `WinAuth.Cli` release is the maintained target in this fork. It imports standard
7+
`otpauth://` text exports, supports normal TOTP/HOTP plus Steam Guard's 5-character code format,
8+
and stores entries in a local XML vault. The original WinAuth Windows GUI source is retained below
9+
for provenance and compatibility reference.
10+
11+
Latest CLI release:
12+
13+
<https://github.com/githubhjs/winauth-running-on-all-OS.cli/releases/latest>
14+
15+
Download `winauth-cli-mono.zip`, extract it, and run:
16+
17+
```sh
18+
./winauth-cli --help
19+
./winauth-cli import --uri 'otpauth://totp/Example:email?secret=JBSWY3DPEHPK3PXP&issuer=Example'
20+
./winauth-cli add --type steam --name steam --secret JBSWY3DPEHPK3PXP
21+
./winauth-cli code steam
22+
```
23+
24+
On Linux/macOS, install Mono runtime first. On Ubuntu:
25+
26+
```sh
27+
sudo apt-get install -y mono-runtime
28+
```
29+
30+
On macOS with Homebrew:
31+
32+
```sh
33+
brew install mono
34+
```
35+
36+
## Original Windows Authenticator
237

338
*WinAuth is a portable, open-source Authenticator for Windows that provides counter or time-based RFC 6238 authenticators and common implementations, such as the Google Authenticator. WinAuth can be used with many Bitcoin trading websites as well as games, supporting Battle.net (World of Warcraft, Hearthstone, Heroes of the Storm, Diablo), Guild Wars 2, Glyph (Rift and ArcheAge), WildStar, RuneScape, SWTOR and Steam.*
439

0 commit comments

Comments
 (0)