This repository was archived by the owner on Jul 14, 2019. It is now read-only.

Home

Jump to bottom

Alex Ford edited this page Sep 13, 2013 · 34 revisions

shotgun

NOTE: Shotgun 3.0.0 and higher now uses a new asynchronous model allowing you to do asynchronous work within your command modules. This document has been updated to reflect the changes to the API. Version 3.0.0 and higher is no longer compatible with previous versions. If you use shotgun-client for web-based shell functionality then please update to shotgun-client v3.1.0 or higher.

Shotgun is a UI agnostic command shell. It allows you to quickly and easily write commands and plug them into the shell framework. Rather than assuming the UI, such as the Javascript console, shotgun returns a result object that acts as a set of instructions so that any application can easily consume it, including web applications. In fact, I took the liberty of writing a separate module called shotgun-client that makes it simple to integrate shotgun with any web application.

[Module Installation]
[Getting Started]
[Creating Your First Command Module]
[Built-in Commands]
[Command Context]
[Publishing Your Command Modules to NPM]