https://github.com/kontena/kontena-plugin-shell

Kontena Shell plugin, also known as KOSH.
https://github.com/kontena/kontena-plugin-shell

cli console containers interactive kontena microservices orchestration tty

Last synced: about 1 year ago
JSON representation

Kontena Shell plugin, also known as KOSH.

• Host: GitHub
• URL: https://github.com/kontena/kontena-plugin-shell
• Owner: kontena
• License: apache-2.0
• Created: 2017-03-29T09:00:34.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-02-14T07:35:14.000Z (over 8 years ago)
• Last Synced: 2024-04-25T15:02:21.872Z (about 2 years ago)
• Topics: cli, console, containers, interactive, kontena, microservices, orchestration, tty
• Language: Ruby
• Homepage:
• Size: 2.16 MB
• Stars: 2
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# Kontena Shell

[![Build Status](https://travis-ci.org/kontena/kontena-plugin-shell.svg?branch=master)](https://travis-ci.org/kontena/kontena-plugin-shell)

[![Join the chat at https://slack.kontena.io](https://slack.kontena.io/badge.svg)](https://slack.kontena.io)

[![Join the chat at https://gitter.im/kontena/kontena](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/kontena/kontena?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

[![asciicast](kosh.gif)](https://asciinema.org/a/afj8mw5yc4itvmpvmx0pu13ha)

Kontena Shell, or KOSH for short, is an interactive console interface for the [Kontena CLI](https://github.com/kontena/kontena).

Features:

- Command context switching, for example jump to stack context and use `ls` and `install` instead of `kontena stack ls` and `kontena stack install`

- Prompt shows current master and grid

- Command history

- Batch commands

- Tab completion

- ...

## Installation

```console

$ kontena plugin install shell

```

## Usage

Starting the console:

```console

$ kontena shell

```

or:

```console

$ kosh

```

You can enter regular Kontena CLI subcommands without `kontena`:

```batch

kontena-master/grid-name > master ls

Name                     Url

kontena-master           http://192.168.66.100:8080

```

Or enter a command context:

```batch

kontena-master/grid-name > grid

kontena-master/grid-name grid > ls

Name                           Nodes    Services     Users

grid-name *                    2        1            1

test                           0        0            2

```

To go up in the context, use `..`:

```batch

kontena-master/foo grid > ..

kontena-master/foo > _

```

Or go to top with `/`:

```batch

kontena-master/foo > master user

kontena-master/foo master user > /

kontena-master/foo > _

```

Or run commands from another context:

```batch

kontena-master/foo master user > / grid ls

Name                           Nodes    Services     Users

grid-name *                    2        1            1

kontena-master/foo master user > _

```

Use `help` to see help:

```batch

kontena-master/foo grid > help

Usage:

      SUBCOMMAND [ARG] ...

Parameters:

    SUBCOMMAND                    subcommand

    [ARG] ...                     subcommand arguments

...

```

## Contributing

1. Fork it ( https://github.com/kontena/kontena-plugin-shell )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

## License

Kontena Shell Plugin is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE.txt) for full license text.