Skip to content

activate

Synopsis

The activate subcommand activates an existing Olares account. It requires the user's Olares ID, password, and 12-word mnemonic phrase to complete the activation.

bash
olares-cli user activate <Olares ID> [options]

Arguments

ArgumentDescriptionRequired
<Olares ID>Specifies the unique identifier for the Olares user account
to be activated.
Similar to an email address like [email protected].
Yes

Options

OptionShortUsageRequiredDefault
--bflSpecifies the Backend For Launcher (BFL) service URL, such as https://example.com.Nohttp://127.0.0.1:30180
--enable-tunnelEnables or disables tunnel mode for activation.Nofalse
--help-hDisplays help information.NoN/A
--hostSpecifies the Fast Reverse Proxy (FRP) host. Only used when --enable-tunnel option is set to true.NoN/A
--jwsSpecifies the FRP JWS token. Only used when --enable-tunnel option is set to true.NoN/A
--languageSets the system language.Noen-US
--locationSets the timezone location.NoAsia/Shanghai
--mnemonicSpecifies the 12-word mnemonic phrase required for activation.YesN/A
--password-pSpecifies the Olares login password for authentication.YesN/A
--reset-passwordSpecifies the new password to set during password reset. This option is required only when performing a password reset.NoN/A
--vaultSpecifies the Vault service URL, such as https://example.com.Nohttp://127.0.0.1:30180

Examples

bash
# Activate an Olares user account
olares-cli user activate [email protected] -p "HerPassWord"  --mnemonic "apple banana cherry door eagle forest grape house island jacket kite lemon"

# Activate an Olares user account with tunnel mode enabled
olares-cli user activate [email protected] -p "HisPassWord"  --enable-tunnel --host "frp-gateway.olares.com"  --jws "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.demo.signature"  --bfl http://127.0.0.1:30180 --vault http://127.0.0.1:30180/server  --mnemonic "apple banana cherry door eagle forest grape house island jacket kite lemon"

# Activate an Olares user account with specific language and timezone settings
olares-cli user activate [email protected] -p "AnotherPassWord"  --mnemonic "alpha beta gamma delta epsilon zeta eta theta iota kappa lambda mu"  --language "en-US" --location "America/New_York"