{"id":19351708,"url":"https://github.com/operable/cogctl","last_synced_at":"2025-04-23T07:31:06.761Z","repository":{"id":78638179,"uuid":"48858671","full_name":"operable/cogctl","owner":"operable","description":"CLI admin interface for Cog","archived":false,"fork":false,"pushed_at":"2018-07-11T16:25:35.000Z","size":612,"stargazers_count":3,"open_issues_count":6,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-02T09:44:58.779Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/operable.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.MD","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2015-12-31T18:27:01.000Z","updated_at":"2018-05-18T17:45:53.000Z","dependencies_parsed_at":null,"dependency_job_id":"e15c1ef1-b8fa-416a-ad79-269b89d860e5","html_url":"https://github.com/operable/cogctl","commit_stats":null,"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operable%2Fcogctl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operable%2Fcogctl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operable%2Fcogctl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/operable%2Fcogctl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/operable","download_url":"https://codeload.github.com/operable/cogctl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250391131,"owners_count":21422846,"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-11-10T04:36:59.910Z","updated_at":"2025-04-23T07:31:06.748Z","avatar_url":"https://github.com/operable.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"cogctl: Command-Line Administration Interface for Cog\n#####################################################\n\n[![Build Status](https://travis-ci.org/operable/cogctl.svg?branch=master)](https://travis-ci.org/operable/cogctl)\n[![Coverage Status](https://coveralls.io/repos/github/operable/cogctl/badge.svg?branch=master)](https://coveralls.io/github/operable/cogctl?branch=master)\n\n`cogctl` is a CLI tool for administering a\n[Cog](https://github.com/operable/cog) chat server installation.\n\n# Installation\n\nBinaries for musl-based (e.g. Alpine Linux) and libc-based\n(e.g. Ubuntu) Linux distributions, as well as for MacOS are available\non the [latest Cog release\npage](https://github.com/operable/cog/releases). If you would like to\nbuild an executable for another platform, read on for how to set up a\nlocal development and build environment.\n\nOnce you have a binary, you may run it from anywhere you like; it is\ncompletely self-contained and stand-alone.\n\n# Configuring\n\n`cogctl` uses an INI-formatted configuration file, conventionally\nnamed `.cogctl` in your home directory. This is where you can store\nconnection credentials to allow `cogctl` to interact with Cog's REST\nAPI.\n\nAn example file might look like this:\n```\n[defaults]\nprofile = cog\n\n[cog]\npassword = \"seekrit#password\"\nurl = https://cog.mycompany.com:4000\nuser = me\n\n[preprod]\npassword = \"anotherseekrit#password\"\nurl = https://cog.preprod.mycompany.com:4000\nuser = me\n```\n\nComments begin with a `#` character; if your password contains a `#`,\nsurround the entire password in quotes, as illustrated above.\n\nYou can store multiple \"profiles\" in this file, with a different name\nfor each (here, we have `cog` and `preprod`). Whichever one is noted\nas the default (in the `defaults` section) will be used by\n`cogctl`. However, you can pass the `--profile=$PROFILE` option to\n`cogctl` to use a different set of credentials.\n\nWhile you can add profiles to this file manually, you can also use the\n`cogctl profile create` command to help.\n\n# Getting Help\n\nThe `cogctl` executable contains a number of commands and\nsubcommands. Help is available for all of them by passing the `--help`\noption. Start with `cogctl --help`, and go from there.\n\n# Local Development\n\nThis is a Python 3 project. On MacOS, you can install this with\nHomebrew:\n\n```sh\nbrew install python3\npip3 install --upgrade pip\n```\n\nTo set up an isolated development environment, use `virtualenv`. The\n`virtualenvwrapper` software makes this easier to manage, and is\ndescribed below.\n\nFirst we'll setup virtualenvwrapper.\n\n```sh\npip3 install virtualenvwrapper\nexport VIRTUALENVWRAPPER_PYTHON=/usr/local/bin/python3\nexport WORKON_HOME=~/.virtualenvs\nsource /usr/local/bin/virtualenvwrapper.sh\n```\n\nNote: You will probably want to add those env vars and source the\nvirtualenvwrapper.sh in your shell rc file.\n\nFinally we can set up our virtual env.\n\n```sh\nmkvirtualenv cogctl\nworkon cogctl\nadd2virtualenv .\nmake python-deps\n```\n\nThe final `add2virtualenv` command ensures that the project is on your\n`PYTHONPATH`. This allows you to run the `cucumber` acceptance tests\nlocally (although it runs based on the code directly, and not on the\n`pyinstaller`-built binary).\n\nTo set up for Cucumber tests, do the following\n\n```sh\nmake ruby-deps\nbin/cucumber\n```\n\nTo build a stand-alone binary for your current platform, run `make build`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foperable%2Fcogctl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foperable%2Fcogctl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foperable%2Fcogctl/lists"}