https://github.com/fabrix-app/fab-cli
Fabrix CLI
https://github.com/fabrix-app/fab-cli
cli command-line-interface fabrix nodejs typescript
Last synced: about 1 year ago
JSON representation
Fabrix CLI
- Host: GitHub
- URL: https://github.com/fabrix-app/fab-cli
- Owner: fabrix-app
- License: mit
- Created: 2018-06-30T18:03:01.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-23T20:46:26.000Z (over 3 years ago)
- Last Synced: 2025-03-17T22:55:07.440Z (about 1 year ago)
- Topics: cli, command-line-interface, fabrix, nodejs, typescript
- Language: TypeScript
- Size: 513 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fabrix CLI

[![Gitter][gitter-image]][gitter-url]
[![NPM version][npm-image]][npm-url]
[![Build Status][ci-image]][ci-url]
[![Test Coverage][coverage-image]][coverage-url]
[![Dependency Status][daviddm-image]][daviddm-url]
[![Follow @FabrixApp on Twitter][twitter-image]][twitter-url]
## Install
Install the Fabrix CLI globally.
```sh
$ npm install @fabrix/fab-cli -g
```
## Usage
See the options for the CLI
```sh
$ fab --help
```
Create a New Fabrix Application
```sh
$ fab app
```
## FAQ
See https://github.com/fabrix-app/fabrix/wiki/FAQ
## Contributing
We love contributions! Please check out our [Contributor's Guide](https://github.com/fabrix-app/fabrix/blob/master/.github/CONTRIBUTING.md) for more information on how our projects are organized and how to get started.
### Release Instructions
When the master is tagged with a release, it will automatically publish to npm, updates the Changelog and bumps the version. Fabrix uses the [standard-version library](https://www.npmjs.com/package/standard-version) to manage it all.
To run a patch release:
```bash
npm run release -- --release-as patch
```
and then commit to master. `git push --follow-tags origin master`
You can also test the release by running
```bash
npm run release -- --dry-run --release-as patch
```
## License
[MIT](https://github.com/fabrix-app/fabrix-cli/blob/master/LICENSE)
[npm-image]: https://img.shields.io/npm/v/@fabrix/fab-cli.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@fabrix/fab-cli
[ci-image]: https://img.shields.io/circleci/project/github/fabrix-app/fab-cli/master.svg
[ci-url]: https://circleci.com/gh/fabrix-app/fab-cli/tree/master
[daviddm-image]: http://img.shields.io/david/fabrix-app/fab-cli.svg?style=flat-square
[daviddm-url]: https://david-dm.org/fabrix-app/fab-cli
[gitter-image]: http://img.shields.io/badge/+%20GITTER-JOIN%20CHAT%20%E2%86%92-1DCE73.svg?style=flat-square
[gitter-url]: https://gitter.im/fabrix-app/fabrix
[twitter-image]: https://img.shields.io/twitter/follow/FabrixApp.svg?style=social
[twitter-url]: https://twitter.com/FabrixApp
[coverage-image]: https://img.shields.io/codeclimate/coverage/github/fabrix-app/fab-cli.svg?style=flat-square
[coverage-url]: https://codeclimate.com/github/fabrix-app/fab-cli/coverage