{"id":15018716,"url":"https://github.com/kwakwaversal/bash-completion-plugins-sqitch","last_synced_at":"2026-03-27T02:32:45.439Z","repository":{"id":56838575,"uuid":"120819181","full_name":"kwakwaversal/bash-completion-plugins-sqitch","owner":"kwakwaversal","description":"Bash completion for sqitch (partial) - https://p3rl.org/Bash::Completion::Plugins::Sqitch","archived":false,"fork":false,"pushed_at":"2018-03-02T00:33:01.000Z","size":20,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-19T17:41:31.488Z","etag":null,"topics":["bash-completion","perl","perl-module","sqitch"],"latest_commit_sha":null,"homepage":"","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kwakwaversal.png","metadata":{"files":{"readme":"README.md","changelog":"Changes","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-08T21:17:48.000Z","updated_at":"2018-03-02T10:56:34.000Z","dependencies_parsed_at":"2022-08-28T23:23:06.118Z","dependency_job_id":null,"html_url":"https://github.com/kwakwaversal/bash-completion-plugins-sqitch","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kwakwaversal%2Fbash-completion-plugins-sqitch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kwakwaversal%2Fbash-completion-plugins-sqitch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kwakwaversal%2Fbash-completion-plugins-sqitch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kwakwaversal%2Fbash-completion-plugins-sqitch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kwakwaversal","download_url":"https://codeload.github.com/kwakwaversal/bash-completion-plugins-sqitch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243318748,"owners_count":20272137,"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":["bash-completion","perl","perl-module","sqitch"],"created_at":"2024-09-24T19:52:21.208Z","updated_at":"2025-12-28T08:37:36.624Z","avatar_url":"https://github.com/kwakwaversal.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NAME\n\nBash::Completion::Plugins::Sqitch - bash completion for Sqitch\n\n# SYNOPSIS\n\n    # Will install App::Sqitch and Bash::Completion if they aren't installed\n    $ cpanm Bash::Completion::Plugins::Sqitch;\n\n    # Add newly created Sqitch Bash::Completion plugin to current session. (See\n    # \"SETTING UP AUTO-COMPLETE\" to permanently add completions for `sqitch`.)\n    $ eval \"$(bash-complete setup)\"\n\n    # Magical tab completion for all things Sqitch! (well, kind of - see below)\n    $ sqitch \u003ctab\u003e\u003ctab\u003e\n\n# DESCRIPTION\n\n[Bash::Completion::Plugins::Sqitch](https://metacpan.org/pod/Bash::Completion::Plugins::Sqitch) is a [Bash::Completion](https://metacpan.org/pod/Bash::Completion) plugin for\n[App::Sqitch](https://metacpan.org/pod/App::Sqitch).\n\nThe functionality of this plugin is heavily dependent and modelled around the\ndesign of [App::Sqitch](https://metacpan.org/pod/App::Sqitch) version `0.9996`. As long as [App::Sqitch](https://metacpan.org/pod/App::Sqitch) doesn't\ndrastically change, things should be fine. I cannot guarantee that it will work\nfor older versions of [App::Sqitch](https://metacpan.org/pod/App::Sqitch), so update to the latest version if you\nhave any problems.\n\nCurrently this completion module only returns completions for subcommands\n(e.g., deploy, verify, revert etc.). It does _not_ return `sqitch [options]` yet, nor sub-subcommands - I will add them in newer versions.\n\nIt works by using the `App::Sqitch::Command::` namespace to list the `sqitch`\nsubcommands, and takes advantage of each subcommand providing the\n[Getopt::Long](https://metacpan.org/pod/Getopt::Long) options as accessible methods. As such, this means that the\nauto-complete candidates should track new subcommands and options that are\nadded or deprecated. Once downside to this is that some of the options that are\nincluded in the auto-complete candidate list aren't part of the official `$subcommand --help` for a particular subcommand.\n\nN.B., Sqitch auto-completion works best if you're in the sqitch folder (the one\nwith the `sqitch.conf` and `sqitch.plan` in it - which is generally how I use\nit all the time anyway.\n\n# EXTRAS\n\nExtended auto-complete options are available in certain circumstances.\n\n## --target\n\n    $ sqitch target add dev db:pg://username:password@localhost/somedatabase\n\n    # sqitch.conf\n    ...\n    [target \"dev\"]\n        uri = db:pg://username:password@localhost/somedatabase\n    ...\n\n    $ sqitch verify --target \u003ctab\u003e\u003ctab\u003e\n\nWhen the option `--target` is recognised anywhere in the list of options, the\n`sqitch.conf` file is read, and any `targets` are returned as candidates.\n\nN.B., this extra requires that your `cwd` is the sqitch directory with the\n`sqitch.plan` file.\n\n## db:pg\n\n    # .bashrc or .bash_profile\n    #\n    # auto-complete won't work for the [database] with the default\n    # COMP_WORDBREAKS, as such I globally remove `:` and `=`. This isn't for\n    # everyone - but this extra will *not* work without doing it.\n    export COMP_WORDBREAKS=${COMP_WORDBREAKS/:/}\n    export COMP_WORDBREAKS=${COMP_WORDBREAKS/=/}\n\n    $ sqitch status db:pg:\u003ctab\u003e\u003ctab\u003e\n\nI'm hoping this is more useful in the future because there is a bug with most\nof the useful sqitch subcommands in that they don't honour the `service`\nparamenter in the `[database]` string. It works for status though!\n\nN.B., this currently only works for the `pg` engine as it uses\n[Pg::ServiceFile](https://metacpan.org/pod/Pg::ServiceFile) to autocomplete the `database` based on the service names.\n\n# SETTING UP AUTO-COMPLETE\n\nThe instructions for setting up [Bash::Completion](https://metacpan.org/pod/Bash::Completion) don't work under all Perl\nenvironments - particularly [plenv](https://github.com/tokuhirom/plenv). The\ninstructions below should work.\n\n## bash\n\n    # Stick this into your .bashrc or .bash_profile\n    eval \"$(bash-complete setup)\"\n\n## zsh\n\n    # Stick this into your .zshrc\n    autoload -U bashcompinit\n    bashcompinit\n    eval \"$(bash-complete setup)\"\n\n# AUTHOR\n\nPaul Williams \u003ckwakwa@cpan.org\u003e\n\n# COPYRIGHT\n\nCopyright 2018- Paul Williams\n\n# LICENSE\n\nThis library is free software; you can redistribute it and/or modify it under\nthe same terms as Perl itself.\n\n# SEE ALSO\n\n[App::Sqitch](https://metacpan.org/pod/App::Sqitch),\n[Bash::Completion](https://metacpan.org/pod/Bash::Completion).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkwakwaversal%2Fbash-completion-plugins-sqitch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkwakwaversal%2Fbash-completion-plugins-sqitch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkwakwaversal%2Fbash-completion-plugins-sqitch/lists"}