vue-command

A fully working, most feature-rich Vue.js terminal emulator. See the demo.

Features

• Parse arguments with yargs-parser
• Search history (with ↑/↓)
• White/Dark theme support
• Autocompletion resolver (with ↹)
• Supports asynchronous commands
• Customize terminal with slots

Installation

$ npm i vue-command --save

Properties

Commands

commands is an object containing key-value pairs where key is the command and the value is a function that will be called with the yargs arguments. The function can return a Promise resolving to a HTML String, that will be used as the output or a Vue.js component, which you can use for more complex functions.

In your component, you have access to the following instance properties:

Built-in

Key-value pairs where key is command and value is function with yargs arguments and $data from instance. Function should return String or Promise that resolves to String.

Events

Slots

Bar

It's possible to fully customize the terminal bar using slots. Note: If using the bar slot, the property hide-bar will be ignored.

<template>
  <vue-command
    :commands="commands">
    <div slot="bar">
      Pokedex
    </div>
  </vue-command>
</template>

Usage

You can either return a String or a Vue.js component.

String

Returns the color of the Pokémon "Pikachu".

<template>
  <vue-command
    :yargs-options="{ alias: { color: ['colour'] } }"
    :commands="commands"
  />
</template>

<script>
import VueCommand from 'vue-command'
import 'vue-command/dist/vue-command.css'

export default {
  components: {
    VueCommand
  },

  data: () => ({
    commands: {
      // yargs arguments
      pokedex: ({ color, _ }) => {
        if (color && _[1] === 'pikachu') {
          return 'yellow'
        }
        
        // Return help since no match
        return `Usage: pokedex pokemon [option]<br><br>

        Example: pokedex pikachu --color
        `
      }
    }
  })
}
</script>

<style lang="scss">
  .vue-command {
    .term {
      -webkit-border-radius: 8px;
      -moz-border-radius: 8px;
      border-radius: 8px;
    }

    .term-std {
      min-height: 300px;
      max-height: 300px;
      overflow-y: scroll;
    }
  }
</style>

Component

Simulates the Nano editor available in many shells.

<template>
  <div v-if="$_isRunning">
    <textarea 
      ref="nano" 
      @keydown.ctrl.88="$_done()">
      This is a text editor! Press Ctrl + X to leave.
    </textarea>
  </div>
</template>

<script>
export default {
  mounted () {
    this.$_setIsFullscreen(true)
    this.$refs.nano.focus()
  }
}
</script>

<style lang="scss" scoped>
div,
textarea {
  display: block;
  width: 100%;
  height: 100%;
}
</style>

Now the command has to return the component.

<template>
  <vue-command :commands="commands" />
</template>

<script>
import VueCommand from 'vue-command'
import 'vue-command/dist/vue-command.css'

import nano from './NanoEditor.vue'

export default {
  components: {
    VueCommand
  },

  data: () =>  ({
    commands: { 
      nano: () => nano 
    }
  })
}
</script>

Browser support

This library uses the ResizeObserver to track if the terminals inner height changes. You may need a pollyfill to support your target browser.

Projects using vue-command

• docker-management-dashboard - A management dashboard for your local docker containers
• saber-theme-klieh - A Saber theme mimicking a terminal
• ts-git - A naïve implementation of git, written in TypeScript
• curvy-idle-game - Short idle game where you get to pat her

Author

Julian Claus and contributors. Special thanks to krmax44 for the amazing work!

License

MIT