{"id":13542511,"url":"https://github.com/CrunchyData/bridge-cli","last_synced_at":"2025-04-02T10:30:53.187Z","repository":{"id":37050837,"uuid":"411434966","full_name":"CrunchyData/bridge-cli","owner":"CrunchyData","description":"CLI for Crunchy Bridge","archived":false,"fork":false,"pushed_at":"2024-12-11T16:41:00.000Z","size":601,"stargazers_count":25,"open_issues_count":12,"forks_count":5,"subscribers_count":15,"default_branch":"main","last_synced_at":"2025-04-01T10:35:37.849Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Crystal","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CrunchyData.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-28T20:51:48.000Z","updated_at":"2025-03-18T17:31:02.000Z","dependencies_parsed_at":"2024-01-16T15:50:38.498Z","dependency_job_id":"18f71574-4e39-44c7-8c1c-7d3bc9bc9a4e","html_url":"https://github.com/CrunchyData/bridge-cli","commit_stats":null,"previous_names":[],"tags_count":49,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrunchyData%2Fbridge-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrunchyData%2Fbridge-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrunchyData%2Fbridge-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrunchyData%2Fbridge-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CrunchyData","download_url":"https://codeload.github.com/CrunchyData/bridge-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246796815,"owners_count":20835448,"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":[],"created_at":"2024-08-01T10:01:09.305Z","updated_at":"2025-04-02T10:30:52.703Z","avatar_url":"https://github.com/CrunchyData.png","language":"Crystal","funding_links":[],"categories":["Crystal","others"],"sub_categories":[],"readme":"# cb\n\nA CLI for Crunchy Bridge with very good tab completion.\n\n![cb tab animation](https://user-images.githubusercontent.com/1973/124816125-0112ff80-df1d-11eb-944c-986e6b628e92.gif)\n\n## Installation\n\n- For homebrew (on [macOS](https://brew.sh) or [linux](https://docs.brew.sh/Homebrew-on-Linux))\n  `brew install CrunchyData/brew/cb`. This will install both `cb` and the fish shell tab\n  completions for you.\n- For others, download the [latest release](https://github.com/CrunchyData/bridge-cli/releases),\n  put it somewhere in your path, and be sure to manually install shell tab\n  completions from the `completions` directory.\n\n## Getting started\n\nFirst login to your Crunchy Bridge account by running `cb login`.\n\n```\n$ cb login\nPress any key to open a browser to login or q to exit:\nWaiting for login... done\nLogged in as user@example.com\n```\n\nIf you'd prefer to use an API key then you can create one for your\n[account](https://crunchybridge.com/account/api-keys) and set the `CB_API_KEY`\nenvironment variable.\n\n**Note:** If the `CB_API_KEY` environment variable is set, then `cb login` will\nnot work until it is unset.\n\n## Usage\n\nOnce you are logged in, you can run `cb list` to see all of your clusters, and\n`cb psql \u003ccluster id\u003e` to securely connect to your database or `cb scope` to\nrun health checks against it. There are many more commands that you can use to\nmanage things such as log destinations, firewall rules, and more.\n\nTo see what commands are available run `cb --help`, and to see more detailed\ninformation for a given command add `--help` to it, for example `cb create\n--help`.\n\nIf you use the [fish command line shell](https://fishshell.com) and have the\ncompletions installed for you (either automatically through homebrew or\notherwise), nearly all arguments can be intelligently completed for you. This\nincludes all cluster IDs available to just your account, in addition to normal\nsubcommands and flags. Also where possible the current arguments you've given\nare taken into consideration. For example if you're creating a new cluster on\nAWS, instances sizes on Azure or regions in GCP will not be shown.\n\n## Development\n\nInstall dependencies: [crystal](https://crystal-lang.org/install/)\n\nYou can run quick checks by executing `src/cli.cr` directly. While this can be\nhandy, it is slow because the executable is being built each time, then\nexecuted. To build a development version run `make` or `shards build`. The\nbinary will be at `bin/cb` by default. There is a helper script\n`dev_setup.fish` which puts the local bin directory in your path so the `cb` in\nthat directory will be ran, as well as an `scb` alias for running `src/cli.cr`.\nIt will also set up completions for each.\n\n`crystal tool --format` will format the code as required. It is useful to have\nyour editor run this for you on save.\n\n\n### testing\n\nYou can run `crystal spec` to run all of the specs, or `make test` to also run linting checks.\n\n\n### nix\n\nIf you install nix, the included flake devShell will automatically have all\ndependencies, and you can simply run `check` to run all specs and linting.\n\n## Contributing\n\n1. Fork it (\u003chttps://github.com/CrunchyData/bridge-cli/fork\u003e)\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Include an entry in the changelog\n6. Create a new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCrunchyData%2Fbridge-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCrunchyData%2Fbridge-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCrunchyData%2Fbridge-cli/lists"}