{"id":28551986,"url":"https://github.com/heroku/heroku-connect-plugin","last_synced_at":"2025-07-04T09:31:37.917Z","repository":{"id":31185357,"uuid":"34745923","full_name":"heroku/heroku-connect-plugin","owner":"heroku","description":"CLI plugin for Heroku Connect (experimental)","archived":false,"fork":false,"pushed_at":"2025-04-21T11:54:41.000Z","size":605,"stargazers_count":23,"open_issues_count":14,"forks_count":9,"subscribers_count":93,"default_branch":"main","last_synced_at":"2025-06-10T04:07:53.620Z","etag":null,"topics":["heroku","heroku-cli-plugin","heroku-connect"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/heroku.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-04-28T17:40:42.000Z","updated_at":"2024-12-18T00:02:24.000Z","dependencies_parsed_at":"2023-01-14T18:30:33.855Z","dependency_job_id":"eb2e9f2d-17de-43a9-aaec-732522b17244","html_url":"https://github.com/heroku/heroku-connect-plugin","commit_stats":{"total_commits":243,"total_committers":19,"mean_commits":"12.789473684210526","dds":0.5308641975308642,"last_synced_commit":"f654d34a3622a6b100540a42552ff8f6b69cb91a"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/heroku/heroku-connect-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroku%2Fheroku-connect-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroku%2Fheroku-connect-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroku%2Fheroku-connect-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroku%2Fheroku-connect-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/heroku","download_url":"https://codeload.github.com/heroku/heroku-connect-plugin/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/heroku%2Fheroku-connect-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263163326,"owners_count":23423510,"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","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":["heroku","heroku-cli-plugin","heroku-connect"],"created_at":"2025-06-10T04:07:54.245Z","updated_at":"2025-07-04T09:31:37.909Z","avatar_url":"https://github.com/heroku.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Heroku Connect CLI Plugin\n\n## Install\n\n```shell\n$ heroku plugins:install @heroku-cli/heroku-connect-plugin\nInstalling plugin @heroku-cli/heroku-connect-plugin... installed\n```\n\n## Help\n\n```shell\n$ heroku help connect \n```\n\n## Commands\n\n```text\nheroku connect:db:set                  - Set database parameters\nheroku connect:diagnose                - Display diagnostic information about a connection\nheroku connect:export                  - Export a mapping configuration JSON file\nheroku connect:import FILE             - Import a mapping configuration JSON file\nheroku connect:info                    - Display connection information \nheroku connect:mapping:state MAPPING   - Return the state of a mapping\nheroku connect:mapping:delete MAPPING  - Delete an existing mapping\nheroku connect:mapping:reload MAPPING  - Reload a mapping's data from Salesforce\nheroku connect:pause                   - Pause a connection\nheroku connect:resume                  - Resume a connection\nheroku connect:restart                 - Restart a connection\nheroku connect:sf:auth                 - Authenticate a connection to Salesforce\nheroku connect:state                   - Return the state flag for a single connection\n```\n\n## Examples\n\nDownload an existing mapping configuration\n\n```shell\n$ heroku connect:export\nSaved config-file: app-name-resource-name.json\n```\n\n## Tutorial\n\nMake sure you have a Heroku app, with a Postgres database attached\n\n### Add the Heroku Connect add-on to your app\n\n```shell\n$ heroku addons:create herokuconnect\n```\n\n### Link the new connection (the Heroku Connect add-on instance) to your Heroku user\n\n```shell\n$ heroku connect:info\n```\n\n### Now link the connection to the database, specifying the config var and schema name\n\n```shell\n$ heroku connect:db:set --db=DATABASE_URL --schema=salesforce\nsettings database parameters... done\ndb_key:      DATABASE_URL\nschema_name: salesforce\n```\n\nIf either option is not supplied, this command will ask for a value.\n\n### Authorize the connection to access your Salesforce organization\n\n```shell\n$ heroku connect:sf:auth\nLaunching Salesforce for authorization. If your browser doesn't open, please copy the following URL to proceed:\n\nhttps://login.salesforce.com/services/oauth2/authorize?…\n\nThis will launch your browser for an interactive authorization session.\n```\n\n### Verify that connection is now in 'IDLE' state\n\n```shell\n$ heroku connect:state\nIDLE\n```\n\n### Now restore the exported configuration\n\nThis could be exported using the `connect:export` command or directly through the Heroku Connect dashboard. By editing this configuration file, you can add and edit existing mappings easily.\n\n```shell\n$ heroku connect:import app-name-resource-name.json\nUpload complete\n```\n\nIf you need to delete a mapping after the configuration has been imported, you can use a separate command for that:\n\n```shell\n$ heroku connect:mapping:delete Contact\n```\n\n### Connect to your database to see the data\n\n```shell\n$ heroku pg:psql\n\u003e select * from salesforce.contact;\n```\n\n## Contributing\n\nRead the following:\n\n- [Developing CLI Plugins](https://devcenter.heroku.com/articles/developing-cli-plugins)\n- [Testing CLI Plugins](https://devcenter.heroku.com/articles/testing-cli-plugins)\n- [CLI Style Guide](https://devcenter.heroku.com/articles/cli-style-guide)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheroku%2Fheroku-connect-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheroku%2Fheroku-connect-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheroku%2Fheroku-connect-plugin/lists"}