mirror of
https://github.com/PR0M3TH3AN/SeedPass.git
synced 2025-09-08 07:18:47 +00:00
20 lines
696 B
Markdown
20 lines
696 B
Markdown
# SeedPass Documentation
|
|
|
|
This directory contains supplementary guides for using SeedPass.
|
|
|
|
## Quick Example: Get a TOTP Code
|
|
|
|
Run `seedpass totp <query>` to retrieve a time-based one-time password (TOTP). The
|
|
`<query>` can be a label, title, or index. A progress bar shows the remaining
|
|
seconds in the current period.
|
|
|
|
```bash
|
|
$ seedpass totp "email"
|
|
[##########----------] 15s
|
|
Code: 123456
|
|
```
|
|
|
|
## CLI and API Reference
|
|
|
|
See [advanced_cli.md](advanced_cli.md) for a list of command examples. Detailed information about the REST API is available in [api_reference.md](api_reference.md). When starting the API, set `SEEDPASS_CORS_ORIGINS` if you need to allow requests from specific web origins.
|