Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/goliatone/core.io-cli
core.io CLI toolchain manager
https://github.com/goliatone/core.io-cli
Last synced: 11 days ago
JSON representation
core.io CLI toolchain manager
- Host: GitHub
- URL: https://github.com/goliatone/core.io-cli
- Owner: goliatone
- Created: 2017-10-29T03:03:14.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-04T08:29:49.000Z (almost 2 years ago)
- Last Synced: 2024-10-17T13:55:18.787Z (21 days ago)
- Language: JavaScript
- Size: 717 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## core.io CLI
This is the [core.io][core] CLI tool belt, providing a series of utilities to speed development.
### Installation
Run the following command:
```
$ npm i -g core.io-cli
```
This will expose the `core` command in your terminal:
```
$ core
```
It is also aliased to `cr`.
### Commands
If you run the `help` command you will see a list of the available commands:
```
core 0.0.3 - core.io CLI toolbelt manager
USAGE
core [options]
COMMANDS
shuttle install Install all dependencies
shuttle list List all local domains
shuttle open Open domain in default browser
shuttle share Generate a shareable URL for a project
shuttle restart Restart Caddy and Dnsmasq services
shuttle stop Stop Caddy and Dnsmasq services
shuttle start Start Caddy and Dnsmasq services
shuttle serve Proxy a local domain and save it for quick access
shuttle update Update toolchain
generator add [alias] Add a project template from github or a local directory
generator list List available templates
generator new [output] Create a new project from a project template
generator link [alias] Link local template for development
schema collect [source] [output] Collect metadata from waterline models and generates a JSON schema file
schema generate [source] [output] Generate schema from model data
scaffold compile [source] [output] Generate views from a GUI schema
scaffold open [source] [output] Generate views from a JSON schema
run [application] [environment] Run a core.io application
repl Open REPL window
help Display help for a specific command
GLOBAL OPTIONS
-h, --help Display help
-V, --version Display version
--no-color Disable colors
--quiet Quiet mode - only displays warn and error messages
-v, --verbose Verbose mode - will also output debug messages
```
### Utilities
All the exposed utilities are available as stand alone CLI tools. This is just a convinient wrapper that uses those tools to expedite development of **core.io** applications.
#### Shuttle
With shuttle you can create local environments for development on macOS computers.
It uses [Caddy][caddy] and [Dnsmasq][dnsmasq] to provide a reverse proxy for your local webservers. You can also create a local tunnel which you can share to access your local server remotely- it uses [ngrok][ngrok] under the hood.
You need to have [Homebrew][brew] installed, as it uses brew to install some dependencies.
#### Generator
Create new projects of any type using templates. A template is usually stored as a github repository and provides everything you need to create a new project and get started quickly.
Check out the **core.io** [starter template][starter-template] or a [node template][node-template], you can get an idea of how to create your own templates.
#### Schema
If you application uses [persistence][core.io-persistence] and has models that expose an `schema` property, then you can use this utility to generate a `schema.json` file that can be used as input for scaffolding CRUD views.
#### Scaffold
Using this command and a valid gui-schema file, generated by the `schema` command you can generate CRUD views.
### REPL
**core.io** applications can expose a REPL that can be accessed with this command.
### Run
## License
® License MIT 2017 by goliatone
[brew]:https://brew.sh/
[ngrok]: https://ngrok.com
[caddy]: https://caddyserver.com
[dnsmasq]: http://www.thekelleys.org.uk/dnsmasq/doc.html
[core]:http://node-core.io
[persistence]:https://github.com/goliatone/core.io-persistence
[starter-template]:https://github.com/goliatone/core.io-starter-template
[node-template]:https://github.com/goliatone/template-node-project