{"id":19933026,"url":"https://github.com/kontena/kontena-plugin-shell","last_synced_at":"2025-05-03T11:33:16.037Z","repository":{"id":56880435,"uuid":"86560448","full_name":"kontena/kontena-plugin-shell","owner":"kontena","description":"Kontena Shell plugin, also known as KOSH.","archived":false,"fork":false,"pushed_at":"2018-02-14T07:35:14.000Z","size":2261,"stargazers_count":2,"open_issues_count":1,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-04-25T15:02:21.872Z","etag":null,"topics":["cli","console","containers","interactive","kontena","microservices","orchestration","tty"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/kontena.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2017-03-29T09:00:34.000Z","updated_at":"2018-02-14T09:45:13.000Z","dependencies_parsed_at":"2022-08-20T13:00:13.397Z","dependency_job_id":null,"html_url":"https://github.com/kontena/kontena-plugin-shell","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kontena%2Fkontena-plugin-shell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kontena%2Fkontena-plugin-shell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kontena%2Fkontena-plugin-shell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kontena%2Fkontena-plugin-shell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kontena","download_url":"https://codeload.github.com/kontena/kontena-plugin-shell/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224360219,"owners_count":17298319,"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":["cli","console","containers","interactive","kontena","microservices","orchestration","tty"],"created_at":"2024-11-12T23:12:27.517Z","updated_at":"2024-11-12T23:12:27.998Z","avatar_url":"https://github.com/kontena.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kontena Shell\n\n[![Build Status](https://travis-ci.org/kontena/kontena-plugin-shell.svg?branch=master)](https://travis-ci.org/kontena/kontena-plugin-shell)\n[![Join the chat at https://slack.kontena.io](https://slack.kontena.io/badge.svg)](https://slack.kontena.io)\n[![Join the chat at https://gitter.im/kontena/kontena](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/kontena/kontena?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n[![asciicast](kosh.gif)](https://asciinema.org/a/afj8mw5yc4itvmpvmx0pu13ha)\n\nKontena Shell, or KOSH for short, is an interactive console interface for the [Kontena CLI](https://github.com/kontena/kontena).\n\nFeatures:\n\n- Command context switching, for example jump to stack context and use `ls` and `install` instead of `kontena stack ls` and `kontena stack install`\n- Prompt shows current master and grid\n- Command history\n- Batch commands\n- Tab completion\n- ...\n\n## Installation\n\n```console\n$ kontena plugin install shell\n```\n\n## Usage\n\nStarting the console:\n\n```console\n$ kontena shell\n```\n\nor:\n\n```console\n$ kosh\n```\n\nYou can enter regular Kontena CLI subcommands without `kontena`:\n\n```batch\nkontena-master/grid-name \u003e master ls\nName                     Url\nkontena-master           http://192.168.66.100:8080\n```\n\nOr enter a command context:\n\n```batch\nkontena-master/grid-name \u003e grid\nkontena-master/grid-name grid \u003e ls\nName                           Nodes    Services     Users\ngrid-name *                    2        1            1\ntest                           0        0            2\n```\n\nTo go up in the context, use `..`:\n\n```batch\nkontena-master/foo grid \u003e ..\nkontena-master/foo \u003e _\n```\n\nOr go to top with `/`:\n\n```batch\nkontena-master/foo \u003e master user\nkontena-master/foo master user \u003e /\nkontena-master/foo \u003e _\n```\n\nOr run commands from another context:\n\n```batch\nkontena-master/foo master user \u003e / grid ls\nName                           Nodes    Services     Users\ngrid-name *                    2        1            1\nkontena-master/foo master user \u003e _\n```\n\nUse `help` to see help:\n\n```batch\nkontena-master/foo grid \u003e help\nUsage:\n      SUBCOMMAND [ARG] ...\n\nParameters:\n    SUBCOMMAND                    subcommand\n    [ARG] ...                     subcommand arguments\n...\n```\n\n## Contributing\n\n1. Fork it ( https://github.com/kontena/kontena-plugin-shell )\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. Create a new Pull Request\n\n## License\n\nKontena Shell Plugin is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE.txt) for full license text.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkontena%2Fkontena-plugin-shell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkontena%2Fkontena-plugin-shell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkontena%2Fkontena-plugin-shell/lists"}