Skip to main content

signaloid-cli users update

Update your profile fields and editor preferences.

Synopsis​

signaloid-cli users update [options]

Options​

OptionDescription
--pref <key=value>Set a preference. Repeatable.
--remove <field>Remove a preference field. Repeatable. Allowed values: Editor_Execution_DataSources, Editor_Execution_Core
--role <role>Set your role (conflicts with --clear-role)
--industry <industry>Set your industry (conflicts with --clear-industry)
--clear-roleClear your role
--clear-industryClear your industry
--payload-file <json>JSON file with a Preferences object
--format <type>Output format: table or json (default: json)

Description​

The users update command modifies the mutable parts of your account, i.e., the Role and Industry profile fields, and the Preferences map that holds your Signaloid Cloud Developer Platform Editor settings.

Preferences are merged, not replaced. The command first reads your current preferences, applies the values from --payload-file and then the inline --pref flags, and sends the merged map. A preference you do not mention keeps its current value. To delete one, name it with --remove.

If your update touches only --role or --industry, the preferences map is left out of the request entirely and none of your editor settings are touched.

The signaloid-cli cannot update your email address, display name, and subscription tier.

Examples​

Set a preference:

signaloid-cli users update --pref Editor_Theme=dark

Set multiple preferences at once:

signaloid-cli users update \
  --pref Editor_Theme=dark \
  --pref Editor_Layout_VariableViewer=expanded

Set your role and industry:

signaloid-cli users update --role engineering --industry automotive

Clear your role:

signaloid-cli users update --clear-role

Remove a preference field:

signaloid-cli users update --remove Editor_Execution_Core

Apply preferences from a file:

cat > prefs.json <<'EOF'
{
  "Preferences": {
    "Editor_Theme": "dark",
    "Editor_Execution_Core": "cor_abc123"
  }
}
EOF

signaloid-cli users update --payload-file prefs.json

The file may contain either a bare object of preference keys or an object with a top-level Preferences key, as above. Both are accepted.

Notes​

  • At least one option must be provided.
  • Changes are applied immediately.
  • Use signaloid-cli users me to verify updates to preferences. Neither users me nor the GET /users/{id} endpoint returns Role or Industry, so you cannot read these fields back after you set them.
  • --pref values are parsed as key=value. A value containing = keeps everything after the first separator.

Troubleshooting​

"Not authenticated" Error​

Problem: Command fails with authentication error.

Solutions:

  1. Login first: signaloid-cli auth login
  2. Verify authentication: signaloid-cli auth whoami
  3. Check API key is valid

Update Not Reflected​

Problem: Changes do not appear when running users me.

users me does not return Role or Industry. Changes to these two fields never appear in its output.

Solutions:

  1. Wait a few seconds and try again (API propagation delay)
  2. Verify the update command completed successfully
  3. Check for error messages in the command output

See Also​

Last updated on