# @orbital/core

> Orbital is the CLI framework from the future. Using powerful features from TypeScript, like metadata and decorators, there is no limit to what you can create with Orbital.

Latest version **1.0.0-alpha.30** (published 2018-07-14) · 0 weekly downloads

## Install

```sh
npm install @orbital/core
pnpm add @orbital/core
yarn add @orbital/core
bun add @orbital/core
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-alpha.30 |
| Published | 2018-07-14 |
| First published | 2017-07-30 |
| Weekly downloads | 0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 94.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | wbhob |

## Links

- npm: https://www.npmjs.com/package/@orbital/core
- npm.io page: https://npm.io/package/@orbital/core

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.10
- [winston](https://npm.io/package/winston.md) ^2.4.3
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.12

## Recent versions

- 1.0.0-alpha.30 (latest) — 2018-07-14
- 1.0.0-alpha.26-20171124015326 (nightly) — 2017-11-24
- 1.0.0-alpha.29 — 2018-07-07
- 1.0.0-alpha.28 — 2018-06-27
- 1.0.0-alpha.27 — 2018-06-26
- 1.0.0-alpha.26-20171007120551 — 2017-10-07
- 1.0.0-alpha.26-20171003103320 — 2017-10-04
- 1.0.0-alpha.26 — 2017-10-04
- 1.0.0-alpha.25-20170915024725 — 2017-09-15
- 1.0.0-alpha.25-20170915024439 — 2017-09-15
- 1.0.0-alpha.25-20170912110018 — 2017-09-13
- 1.0.0-alpha.25-20170912063226 — 2017-09-12
- 1.0.0-alpha.25-20170911011822 — 2017-09-11
- 1.0.0-alpha.25-20170910084540 — 2017-09-11
- 1.0.0-alpha.25-20170910083612 — 2017-09-11
- … 65 more at https://npm.io/package/@orbital/core/versions

## README

# Orbital

Orbital is the CLI framework from the future. Using powerful features from TypeScript, like metadata and decorators, there is no limit to what you can create with Orbital.

## Features

- Support for options and parameters (arguments)
- Command and option aliases
- Automatic help generation out of the box
- Git-style subcommands

## Example

Here's an example of the simplest CLI you can build with Orbital.

```ts
import { CLI, Command, OrbitalFactory } from '@orbital/core';

@Command({
    name: 'hello'
})
export class HelloCommand {
    execute() {
        console.log('Hello, World!');
    }
}

@CLI({
    declarations: [
        HelloCommand
    ]
})
export class HelloCLI { }

OrbitalFactory
    .bootstrap(HelloCLI)
    .execute(process.argv)
```

---
_Source: https://npm.io/package/@orbital/core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
