otty / dotfiles

All tools/Salesforce CLI

Salesforce CLI

sfdx

Salesforce CLI simplifies development and build automation when working with your Salesforce org.

Detected by sfdx, sf | macOS, Linux, Windows |developer.salesforce.com

Sync it sfdx.toml

Sync rules

What travels, what stays, what never leaves

Salesforce CLI in your home directory Every rule on this page, by file

· sfdx-config.json Sync

· alias.json Sync

· *@*.json Never synced

· key.json Never synced

· ~/.sf/config.json Sync

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/sfdx.tomlThe file this page is generated from

id = "sfdx"

name = "Salesforce CLI"

homepage = "https://developer.salesforce.com/tools/salesforcecli"

description = "Salesforce CLI simplifies development and build automation when working with your Salesforce org."

# The Salesforce cloud: the CLI ships no separate mark of its own.

icon = "theSVG:salesforce"

# `sf` (v2) and `sfdx` (v7) are the same CLI: sf v2 understands both command

# styles and keeps writing the .sfdx state folder for interoperability.

detect = ["sfdx", "sf"]

# forcedotcom/sfdx-core, src/global.ts:

# SFDX_STATE_FOLDER = '.sfdx' SF_STATE_FOLDER = '.sf'

# SFDX_DIR = path.join(os.homedir(), '.sfdx')

# src/config/config.ts: CONFIG_FILE_NAME = 'config.json' written under

# SF_STATE_FOLDER, plus SFDX_CONFIG_FILE_NAME = 'sfdx-config.json' written

# under .sfdx when Global.SFDX_INTEROPERABILITY is on.

# src/stateAggregator/accessors/aliasAccessor.ts:

# getFileLocation = () => join(homedir(), Global.SFDX_STATE_FOLDER, 'alias.json')

# On Windows these are %USERPROFILE%\.sfdx and %USERPROFILE%\.sf, which resolve

# to the same ~/ paths, so they are not listed twice.

paths = [

"~/.sfdx/sfdx-config.json",

"~/.sfdx/alias.json",

"~/.sf/config.json",

]

exclude = []

# Two kinds of credential live beside those files in ~/.sfdx:

# * the per-org auth files. src/config/authInfoConfig.ts writes

# `${username}.json` in the global .sfdx directory and calls it "an auth

# config file that stores information such as access tokens, usernames".

# A Salesforce username is email-shaped, so *@*.json names them without

# catching sfdx-config.json, alias.json or key.json.

# * src/crypto/keyChainImpl.ts: getSecretFile() = path.join(Global.DIR,

# 'key.json') — the generic-keychain fallback key that decrypts those auth

# files when no OS keychain is available.

secret = ["~/.sfdx/*@*.json", "~/.sfdx/key.json"]

# No machine_lines: target-org, target-dev-hub and org-api-version name orgs

# and API levels the developer works against everywhere, not this laptop.

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/sfdx. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these keeps all credential files out.