Framework for R

Cloud

cloud_login()

Log In to Framework Cloud

Shows what connecting shares, asks for confirmation, then verifies the token and stores it in the native credential store for your platform -- the macOS Keychain, Windows Credential Manager, or Linux Secret Service (via the keyring package) -- falling back to a permission-restricted file in the Framework config directory. This is the whole onboarding:

Usage

cloud_login(token, url = NULL, verify = TRUE, consent = NULL)

Arguments

Name Default Description
token

Your user token from Framework Cloud (Settings -> API tokens).

url NULL

The Framework Cloud server. Defaults to FW_CLOUD_URL, then the server you last logged in to, then https://framework.pub. Plain http is accepted only for localhost and 127.0.0.1.

verify TRUE

Check the token against the server before saving (default TRUE).

consent NULL

Set TRUE to confirm non-interactively (scripts, CI). In an interactive session you are prompted instead. What connecting shares is printed first and documented at the server's /privacy page.

Value

Invisibly, where the token was stored ("keyring" or the file path).

Details

framework::cloud_login("fw_...")

# A self-hosted server, or single-user mode on this machine
framework::cloud_login("fw_...", url = "https://framework.example.edu")
framework::cloud_login("fw_...", url = "http://localhost:8080")

Tokens are stored per server, and the server you log in to becomes this machine's default for cloud_status(), cloud_sync(), and new(). The FW_CLOUD_URL environment variable overrides that default.

Related reference