Skip to content

kontena/kontena-plugin-shell

Repository files navigation

Kontena Shell

Build Status Join the chat at https://slack.kontena.io Join the chat at https://gitter.im/kontena/kontena

asciicast

Kontena Shell, or KOSH for short, is an interactive console interface for the Kontena CLI.

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

$ kontena plugin install shell

Usage

Starting the console:

$ kontena shell

or:

$ kosh

You can enter regular Kontena CLI subcommands without kontena:

kontena-master/grid-name > master ls
Name                     Url
kontena-master           http://192.168.66.100:8080

Or enter a command context:

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 ..:

kontena-master/foo grid > ..
kontena-master/foo > _

Or go to top with /:

kontena-master/foo > master user
kontena-master/foo master user > /
kontena-master/foo > _

Or run commands from another context:

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:

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 for full license text.