What is fperp?
fperp is the official command-line client for the MyFundedPerps REST
API. Every API operation is available as a command with matching flags, so
anything you can do with curl against the API you can do with less typing:
fperp help for the full command list and fperp help <command> for a
command’s flags.
Install
macOS and Linux
/usr/local/bin when that directory is
writable, otherwise to ~/.local/bin. It never asks for elevated privileges:
if the target directory is not writable it stops and tells you instead of
running sudo for you.
Optional environment variables, set before running the installer:
Windows
In PowerShell:fperp.exe in %LOCALAPPDATA%\Programs\fperp and adds
that directory to your user PATH (new terminals pick it up automatically).
Only x64 Windows builds are published.
Verifying a download
Every release ships aSHA256SUMS file and an Ed25519 signature
(SHA256SUMS.sig) alongside its artifacts at
https://cli.myfundedperpetuals.com/vX.Y.Z/. The installers verify the
checksum of what they download, and fperp upgrade additionally verifies the
signature against a public key embedded in the binary, so a tampered release
is never installed.
Authenticate
fperp login opens your browser to approve a new CLI session. After you
approve it, the CLI prints the session’s expiry date and stores the
credential. The session expires on its own; run fperp login again to renew
it. Run fperp login status to see the current session.
On a remote or headless machine (for example over SSH), run
fperp login --manual. The CLI prints a sign-in link instead of waiting for
a browser on the same machine; open it anywhere, approve, and paste the code
the approval page shows.
To use a long-lived API key instead, create one in
API Key Settings
and run fperp login --with-api-key, which reads the key from stdin or a
prompt that does not echo it. fperp login --api-key <key> also works, but
leaves the key in your shell history.
Credentials are stored in your operating system’s credential store (macOS
Keychain, Windows Credential Manager, or the Linux Secret Service). Where no
credential store is available, they fall back to a 0600 config file; see
fperp login --help for the --store options. FPERP_API_KEY and
--api-key on any other command override the stored credential for one-off
use.
fperp logout revokes a browser-approved session and removes the stored
credential.
Stay up to date
fperp upgrade downloads the latest release, verifies the signed checksums,
and replaces the binary in place. Use fperp upgrade --check to see whether a
newer version exists without installing it, and
fperp upgrade --version vX.Y.Z to install a specific release.
The CLI also checks for new releases in the background at most once per day
and prints a one-line notice on stderr when one exists. It never installs
anything on its own. To disable the check entirely, set
FPERP_NO_UPDATE_CHECK=1; the check is also skipped automatically when the
CI environment variable is set.
Uninstall
Runfperp logout first so no credential stays behind in your OS credential
store, then remove the binary (which fperp shows where it is) and delete the
~/.config/fperp directory.