{"id":34681159,"url":"https://github.com/shellyln/tbls-driver-sf-cli-meta","last_synced_at":"2026-05-22T13:37:57.290Z","repository":{"id":288367310,"uuid":"967809206","full_name":"shellyln/tbls-driver-sf-cli-meta","owner":"shellyln","description":"tbls driver for Salesforce CLI's metadata","archived":false,"fork":false,"pushed_at":"2025-04-25T03:16:25.000Z","size":141,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-25T04:24:11.234Z","etag":null,"topics":["database-document","database-schema","documentation","documentation-tool","er-diagram","liam","salesforce","salesforce-cli","salesforce-developers","salesforcedx","tbls"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shellyln.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-17T03:21:49.000Z","updated_at":"2025-04-25T03:16:28.000Z","dependencies_parsed_at":"2025-04-17T17:54:03.324Z","dependency_job_id":null,"html_url":"https://github.com/shellyln/tbls-driver-sf-cli-meta","commit_stats":null,"previous_names":["shellyln/tbls-driver-sf-cli-meta"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/shellyln/tbls-driver-sf-cli-meta","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellyln%2Ftbls-driver-sf-cli-meta","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellyln%2Ftbls-driver-sf-cli-meta/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellyln%2Ftbls-driver-sf-cli-meta/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellyln%2Ftbls-driver-sf-cli-meta/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shellyln","download_url":"https://codeload.github.com/shellyln/tbls-driver-sf-cli-meta/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shellyln%2Ftbls-driver-sf-cli-meta/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28008518,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-24T02:00:07.193Z","response_time":83,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database-document","database-schema","documentation","documentation-tool","er-diagram","liam","salesforce","salesforce-cli","salesforce-developers","salesforcedx","tbls"],"created_at":"2025-12-24T21:11:03.373Z","updated_at":"2025-12-24T21:11:03.837Z","avatar_url":"https://github.com/shellyln.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tbls driver for Salesforce CLI's metadata\n\n[tbls](https://github.com/k1LoW/tbls?tab=readme-ov-file#external-database-driver) external database driver for Salesforce CLI's metadata.  \nDriver for reading \"Source Format\" metadata of Salesforce CLI [sf command](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_install_cli.htm) on local files.\n\n[![Test](https://github.com/shellyln/tbls-driver-sf-cli-meta/actions/workflows/test.yml/badge.svg)](https://github.com/shellyln/tbls-driver-sf-cli-meta/actions/workflows/test.yml)\n[![release](https://img.shields.io/github/v/release/shellyln/tbls-driver-sf-cli-meta)](https://github.com/shellyln/tbls-driver-sf-cli-meta/releases)\n[![Go version](https://img.shields.io/github/go-mod/go-version/shellyln/tbls-driver-sf-cli-meta)](https://github.com/shellyln/tbls-driver-sf-cli-meta)\n\n\u003cimg src=\"https://raw.githubusercontent.com/shellyln/tbls-driver-sf-cli-meta/master/_assets/logo-tbls-driver-sf-cli-meta.svg\" alt=\"logo\" style=\"width:250px;\" width=\"250\"\u003e\n\n## 🪄 Install\n\n### Go install (recommended):\n#### 🪟 Windows prerequirements:\n```bash\nchoco install golang\n# or\n# scoop bucket add main\n# scoop install main/go\n\ngo install github.com/k1LoW/tbls@latest\n```\n* https://community.chocolatey.org/\n* https://scoop.sh/\n\n#### 🍎 Mac prerequirements:\n```bash\nbrew install go\ngo install github.com/k1LoW/tbls@latest\n```\n* https://brew.sh/\n\n#### ⚡️ Install:\n```bash\ngo install github.com/shellyln/tbls-driver-sf-cli-meta@latest\n```\n\n### Manually:\n#### 🪟 Windows prerequirements:\n```bash\nchoco install git\n\nchoco install golang\nchoco install make\n# or\n# scoop bucket add main\n# scoop install main/go\n# scoop install main/make\n\ngo install github.com/k1LoW/tbls@latest\n```\n* https://community.chocolatey.org/\n* https://scoop.sh/\n\n#### 🍎 Mac prerequirements:\n```bash\nbrew install git\nbrew install go\nbrew install make\ngo install github.com/k1LoW/tbls@latest\n```\n* https://brew.sh/\n\n#### ⚡️ Install:\n```bash\ngit clone https://github.com/shellyln/tbls-driver-cli-meta.git\ncd tbls-driver-cli-meta\n\n# Build it and copy the binary to the $GOPATH/bin, which is probably in the PATH.\n# tbls external driver executable SHOULD be in the PATH.\nmake \u0026\u0026 make install\n```\n\n\n## 🚀 Getting Started\nAdd `.tbls.yml` file to your repository.  \nSee [tbls documentation](https://github.com/k1LoW/tbls?tab=readme-ov-file#document-format) and [sample](./.tbls.yml).\n```yaml\n# .tbls.yml\n\n# Relative path to the metadata.\ndsn: sf-cli-meta:.\n# Absolute path to the metadata.\n# dsn: sf-cli-meta:///path/to/repository\n\ndocPath: doc/schema\n\nformat:\n  # Adjust the column width of Markdown format table\n  # Default is false\n  adjust: false\n  # Sort the order of table list and columns\n  # Default is false\n  sort: true\n```\n\nReading `duplicateRules`, `flows`, `globalValueSets`, `matchingRules`, `permissionsets`, `restrictionRules`, `sharingRules`, `triggers` and `objects` metadata.  \nMetadata should be located in the repository as follows:\n```\n.\n└── force-app/\n    └── main/\n        └── default/\n```\n\nRun tbls to generate document.\n```bash\ntbls doc\n```\n[Sample document](sample/README.md)\n\n\n## ⚙️ Config (Optional)\nIf there is a configuration file `.tbls-sf-cli-meta.toml` in the current directory, it is loaded.  \nIt is not required.\n\n```toml\n# If you want only the label name to appear in the comment column of a table column, set to true.\nsuppressFieldDescription = false\n```\n```toml\n# Filter tables.\n# If the `include` key is present, it restricts the table to only those specified.\n# Then, if the `exclude` key is present, it excludes the specified tables.\n# The `include` and `exclude` keys are applied in that order.\n# The wildcard `*` can be used to match multiple characters.\n\ninclude = [\n  '*__c',\n  '*__mdt',\n  'Account',\n  'Contact*',\n]\n\nexclude = [\n  'Baz__*',\n]\n```\n```toml\n# Escapes markdown special characters with a backslash. e.g. `*` -\u003e '\\*'\n# `def` is an object or array of objects such as `tables` or `columns` in the schema.\n# `prop` is a property of an object such as `name` or `type`.\n# 1. both `def` and `prop` match \n# 2. `prop` matches and `def` is an empty string \n# 3. `def` matches and `prop` is an empty string \n# 4. both `def` and `prop` are empty strings\n\n[[escape]]\ndef = ''\nprop = ''\nchar = '$'\n\n[[escape]]\ndef = ''\nprop = 'extra_def'\nchar = '$[~'\n\n[[escape]]\ndef = 'tables'\nprop = ''\nchar = '$['\n\n[[escape]]\ndef = 'tables'\nprop = 'comment'\nchar = '$[*'\n```\n\n## 📦 CI\n### On GitHub Actions:\n\nSee [workflow setting](https://github.com/shellyln/tbls-driver-ci-test/blob/master/.github/workflows/test.yml).\n\n\n## ⚖️ License\n\nMIT  \nCopyright (c) 2025 Shellyl_N and Authors.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshellyln%2Ftbls-driver-sf-cli-meta","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshellyln%2Ftbls-driver-sf-cli-meta","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshellyln%2Ftbls-driver-sf-cli-meta/lists"}