https://github.com/supercharge/cedar
Build beautiful command line applications
https://github.com/supercharge/cedar
cli console supercharge
Last synced: 7 months ago
JSON representation
Build beautiful command line applications
- Host: GitHub
- URL: https://github.com/supercharge/cedar
- Owner: supercharge
- License: mit
- Created: 2021-04-16T14:19:38.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-25T03:27:27.000Z (almost 2 years ago)
- Last Synced: 2025-02-09T10:16:23.908Z (8 months ago)
- Topics: cli, console, supercharge
- Language: TypeScript
- Homepage:
- Size: 137 KB
- Stars: 2
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Cedar
Build beautiful console applications.
Installation ·
Docs ·
API
Follow @marcuspoehls and @superchargejs for updates!
---
## Introduction
The `@supercharge/cedar` package allows you to create beautiful console applications.
## Installation
```
npm i @supercharge/cedar
```
## Docs
Find all the [details for `@supercharge/cedar` in the extensive Supercharge docs](https://superchargejs.com/docs/console).
## Usage
Using `@supercharge/cedar` is pretty straightforward. The package exports a handful of methods that you can reach for when requiring the package:
```js
const { Application } = require('@supercharge/cedar')
async function run () {
const app = new Application('console-app-name')
await app.run()
}
```
## Contributing
Do you miss a function? We very much appreciate your contribution! Please send in a pull request 😊
1. Create a fork
2. Create your feature branch: `git checkout -b my-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request 🚀
## License
MIT © [Supercharge](https://superchargejs.com)
---
> [superchargejs.com](https://superchargejs.com) ·
> GitHub [@supercharge](https://github.com/supercharge) ·
> Twitter [@superchargejs](https://twitter.com/superchargejs)