flamebird
v2.1.4
Published
wonderful task manager for Procfile-based or npm-based applications
Downloads
42
Maintainers
Readme
🚀 Installation
$ npm install -g flamebird
📄 Usage
To start Flamebird you can use fb [command] [options]
(or longer alias flamebird [command] [options]
).
Application provides two commands: fb start
and fb web
(read below).
Need help? Use command:
$ fb --help
# or simply
$ fb
💻 Console version (fb start
)
$ fb start [options]
Run tasks from Procfile
or package.json
Options:
-p, --package
- using package.json for the managing tasks. (:warning: with this option the commandstart
run all tasks frompackage.json
, for resolving it , please use option-t
)-t, --tasks [tasks]
- list of tasks which needs to async run infb start
( example :fb start --tasks start,start:dev,start-server
and then tasks arestart
,start:dev
,start-server
will have been runned asynchronously )
💻 Web version (fb web
)
$ fb web [options]
Launch web-application which is task-manager. That command has more abilities than start
. Web-application is reading Procfile
and package.json
and adding ability to launch scripts inside this files together
Options:
-t, --tasks [tasks]
- list of tasks which will be managing in thefb web
command ( example :fb web --tasks start,start:dev,start-server
and this tasks will be showing in the web-applicationstart
,start:dev
,start-server
)-p, --port <PORT>
- sets the server port, by default5050
-n, --name <NAME>
- sets the project name. Display name of the project in title and header. By default using name of project insidepackage.json
otherwiseflamebird
hotkeys works only if is triggered.
hotkey | action
------------ | -------------
Q,W,E...M,<,>,/ | Open task which assigned to specific key.
SHIFT + R | Run/Stop selected task.
TAB | Switch between Procfile
and package.json
tabs
DEL | Clear logs in selected task
↑ | Partially scroll up logs in selected task
↓ | Partially scroll down logs in selected task
SHIFT + ↑ | Fully scroll up logs in selected task
SHIFT + ↓ | Fully scroll down logs in selected task
SHIFT + A | Run all tasks
SHIFT + S | Stop all tasks
📝 License
Licensed under the MIT License.