{"id":13710831,"url":"https://github.com/dbcli/vcli","last_synced_at":"2025-05-06T19:32:42.082Z","repository":{"id":62587137,"uuid":"41162747","full_name":"dbcli/vcli","owner":"dbcli","description":"Vertica CLI with auto-completion and syntax highlighting","archived":true,"fork":false,"pushed_at":"2017-03-15T01:20:59.000Z","size":1322,"stargazers_count":76,"open_issues_count":6,"forks_count":12,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-18T20:41:53.059Z","etag":null,"topics":["autocomplete","cli","syntax-highlighting","vertica"],"latest_commit_sha":null,"homepage":"","language":"Python","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/dbcli.png","metadata":{"files":{"readme":"README.rst","changelog":"changelog.rst","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-21T15:17:47.000Z","updated_at":"2024-11-07T18:15:17.000Z","dependencies_parsed_at":"2022-11-03T22:10:28.438Z","dependency_job_id":null,"html_url":"https://github.com/dbcli/vcli","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbcli%2Fvcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbcli%2Fvcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbcli%2Fvcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbcli%2Fvcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dbcli","download_url":"https://codeload.github.com/dbcli/vcli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252753741,"owners_count":21799003,"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":["autocomplete","cli","syntax-highlighting","vertica"],"created_at":"2024-08-02T23:01:01.211Z","updated_at":"2025-05-06T19:32:37.049Z","avatar_url":"https://github.com/dbcli.png","language":"Python","funding_links":[],"categories":["Python","Clients","CLI"],"sub_categories":["dbcli"],"readme":"vcli: A REPL for Vertica\n========================\n\n|Build Status| |PyPI|\n\nA Vertica_ client that does auto-completion and syntax highlighting, based on\npgcli_.\n\n.. image:: screenshots/vcli.gif\n\n\nInstallation\n------------\n\nJust install it like a regular Python package::\n\n    $ pip install vcli\n\nYou'll probably see some permission errors if you're installing it on the\nsystem-wide Python. If that's what you want to do, you need to ``sudo``::\n\n    $ sudo pip install vcli\n\nTo upgrade vcli, do::\n\n    $ pip install -U vcli\n\n\nUsage\n-----\n\nConnecting to a Database\n~~~~~~~~~~~~~~~~~~~~~~~~\n::\n\n    $ vcli --help\n    Usage: vcli [OPTIONS] [DATABASE]\n\n    Options:\n      -h, --host TEXT        Database server host address  [default: localhost]\n      -p, --port INTEGER     Database server port  [default: 5433]\n      -U, --user TEXT        Database username  [default: CURRENT_USER]\n      -W, --prompt-password  Prompt for password  [default: False]\n      -w, --password TEXT    Database password  [default: ]\n      -v, --version          Print version and exit\n      --vclirc TEXT          Location of .vclirc file  [default: ~/.vclirc]\n      --help                 Show this message and exit.\n\n**Examples**\n\nUse URL to connect::\n\n    $ vcli vertica://dbadmin:pass@localhost:5433/mydb\n\nPrompt for password::\n\n    $ vcli -h localhost -U dbadmin -W -p 5433 mydb\n\nDon't prompt for password::\n\n    $ vcli -h localhost -U dbadmin -w pass -p 5433 mydb\n\nUse VERTICA_URL environment variable::\n\n    $ VERTICA_URL=vertica://dbadmin:pass@localhost:5433/mydb vcli\n\n\nSpecial Commands\n~~~~~~~~~~~~~~~~\n::\n\n    vcli_demo=\u003e \\h\n    +---------------------+--------------------------------------+\n    | Command             | Description                          |\n    |---------------------+--------------------------------------|\n    | \\#                  | Refresh auto-completions             |\n    | \\?                  | Show help                            |\n    | \\a                  | Aligned or unaligned                 |\n    | \\c[onnect] [DBNAME] | Connect to a new database            |\n    | \\d [PATTERN]        | List or describe tables              |\n    | \\dS [PATTERN]       | List system tables                   |\n    | \\dT [PATTERN]       | List data types                      |\n    | \\df [PATTERN]       | List functions                       |\n    | \\dj [PATTERN]       | List projections                     |\n    | \\dn [PATTERN]       | List schemas                         |\n    | \\dp [PATTERN]       | List access privileges               |\n    | \\ds [PATTERN]       | List sequences                       |\n    | \\dt [PATTERN]       | List tables                          |\n    | \\dtv [PATTERN]      | List tables and views                |\n    | \\du [PATTERN]       | List users                           |\n    | \\dv [PATTERN]       | List views                           |\n    | \\e [FILE]           | Edit the query with external editor  |\n    | \\h                  | Show help                            |\n    | \\i FILE             | Execute commands from file           |\n    | \\l                  | List databases                       |\n    | \\n[+] [NAME]        | List or execute named queries        |\n    | \\nd [NAME]          | Delete a named query                 |\n    | \\ns NAME QUERY      | Save a named query                   |\n    | \\o [FILE]           | Output to file or stdout             |\n    | \\q                  | Quit vcli                            |\n    | \\refresh            | Refresh auto-completions             |\n    | \\t                  | Toggle header                        |\n    | \\timing             | Toggle timing of commands            |\n    | \\x                  | Toggle expanded output               |\n    | \\z [PATTERN]        | List access privileges (same as \\dp) |\n    +---------------------+--------------------------------------+\n\n\nThanks\n------\n\nThanks to pgcli_. Most of the hard work, especially the auto-completion part,\nwere already done well by the pgcli core team. vcli wouldn't be possible if it\nweren't for them.\n\n\n.. |Build Status| image:: https://api.travis-ci.org/dbcli/vcli.svg?branch=master\n    :target: https://travis-ci.org/dbcli/vcli\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/vcli.svg\n    :target: https://pypi.python.org/pypi/vcli/\n    :alt: Latest Version\n\n.. _pgcli: http://pgcli.com\n.. _Vertica: http://www.vertica.com/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbcli%2Fvcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdbcli%2Fvcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbcli%2Fvcli/lists"}