tbls driver for Salesforce CLI's metadata

tbls external database driver for Salesforce CLI's metadata.
Driver for reading "Source Format" metadata of Salesforce CLI sf command on local files.

🪄 Install

Go install (recommended):

🪟 Windows prerequirements:

choco install golang
# or
# scoop bucket add main
# scoop install main/go

go install github.com/k1LoW/tbls@latest

• https://community.chocolatey.org/
• https://scoop.sh/

🍎 Mac prerequirements:

brew install go
go install github.com/k1LoW/tbls@latest

• https://brew.sh/

⚡️ Install:

go install github.com/shellyln/tbls-driver-sf-cli-meta@latest

Manually:

🪟 Windows prerequirements:

choco install git

choco install golang
choco install make
# or
# scoop bucket add main
# scoop install main/go
# scoop install main/make

go install github.com/k1LoW/tbls@latest

• https://community.chocolatey.org/
• https://scoop.sh/

🍎 Mac prerequirements:

brew install git
brew install go
brew install make
go install github.com/k1LoW/tbls@latest

• https://brew.sh/

⚡️ Install:

git clone https://github.com/shellyln/tbls-driver-cli-meta.git
cd tbls-driver-cli-meta

# Build it and copy the binary to the $GOPATH/bin, which is probably in the PATH.
# tbls external driver executable SHOULD be in the PATH.
make && make install

🚀 Getting Started

Add .tbls.yml file to your repository.
See tbls documentation and sample.

# .tbls.yml

# Relative path to the metadata.
dsn: sf-cli-meta:.
# Absolute path to the metadata.
# dsn: sf-cli-meta:///path/to/repository

docPath: doc/schema

format:
  # Adjust the column width of Markdown format table
  # Default is false
  adjust: false
  # Sort the order of table list and columns
  # Default is false
  sort: true

Reading duplicateRules, flows, globalValueSets, matchingRules, permissionsets, restrictionRules, sharingRules, triggers and objects metadata.
Metadata should be located in the repository as follows:

.
└── force-app/
    └── main/
        └── default/

Run tbls to generate document.

tbls doc

Sample document

⚙️ Config (Optional)

If there is a configuration file .tbls-sf-cli-meta.toml in the current directory, it is loaded.
It is not required.

# If you want only the label name to appear in the comment column of a table column, set to true.
suppressFieldDescription = false

# Filter tables.
# If the `include` key is present, it restricts the table to only those specified.
# Then, if the `exclude` key is present, it excludes the specified tables.
# The `include` and `exclude` keys are applied in that order.
# The wildcard `*` can be used to match multiple characters.

include = [
  '*__c',
  '*__mdt',
  'Account',
  'Contact*',
]

exclude = [
  'Baz__*',
]

# Escapes markdown special characters with a backslash. e.g. `*` -> '\*'
# `def` is an object or array of objects such as `tables` or `columns` in the schema.
# `prop` is a property of an object such as `name` or `type`.
# 1. both `def` and `prop` match 
# 2. `prop` matches and `def` is an empty string 
# 3. `def` matches and `prop` is an empty string 
# 4. both `def` and `prop` are empty strings

[[escape]]
def = ''
prop = ''
char = '$'

[[escape]]
def = ''
prop = 'extra_def'
char = '$[~'

[[escape]]
def = 'tables'
prop = ''
char = '$['

[[escape]]
def = 'tables'
prop = 'comment'
char = '$[*'

📦 CI

On GitHub Actions:

See workflow setting.

⚖️ License

MIT
Copyright (c) 2025 Shellyl_N and Authors.