Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bloomberg/stricli
Build complex CLIs with type safety and no dependencies
https://github.com/bloomberg/stricli
cli javascript typescript
Last synced: 5 days ago
JSON representation
Build complex CLIs with type safety and no dependencies
- Host: GitHub
- URL: https://github.com/bloomberg/stricli
- Owner: bloomberg
- License: apache-2.0
- Created: 2024-09-23T16:10:22.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-02T21:05:35.000Z (11 days ago)
- Last Synced: 2024-11-02T21:26:15.419Z (11 days ago)
- Topics: cli, javascript, typescript
- Language: TypeScript
- Homepage: https://bloomberg.github.io/stricli
- Size: 629 KB
- Stars: 658
- Watchers: 10
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Stricli
Build complex CLIs with type safety and no dependencies.
👉 See **[bloomberg.github.io/stricli](https://bloomberg.github.io/stricli/)** for documentation about this framework.
## Contents
- [Rationale](#rationale)
- [Quick Start](#quick-start)
- [Building](#building)
- [Installation](#installation)
- [Contributions](#contributions)
- [License](#license)
- [Code of Conduct](#code-of-conduct)
- [Security Vulnerability Reporting](#security-vulnerability-reporting)
## Rationale
This framework was developed by Bloomberg after evaluating the [available alternatives](https://bloomberg.github.io/stricli/docs/getting-started/alternatives) and developing a set of [guiding principles](https://bloomberg.github.io/stricli/docs/getting-started/principles).
## Quick Start
Check out [the tutorial](https://bloomberg.github.io/stricli/docs/tutorial) to learn how to generate a new Stricli application.
## Building
Run `npm ci` to initialize the repo. We use Nx to manage tasks, so you can run the following to build it:
```
npx nx@latest run-many -t build
```
## Installation
The core Stricli framework is available on npmjs.com, and can be installed with the following command:
```
npm i -P @stricli/core
```
## Contributions
We :heart: contributions.
Have you had a good experience with this project? Why not share some love and contribute code, or just let us know about any issues you had with it?
We welcome issue reports [here](../../issues); be sure to choose the proper issue template for your issue, so that we can be sure you're providing the necessary information.
Before sending a [Pull Request](../../pulls), please make sure you read our [Contribution Guidelines](./.github/CONTRIBUTING.md).
## License
Please read the [LICENSE](LICENSE) file.
## Code of Conduct
This project has adopted a [Code of Conduct](https://github.com/bloomberg/.github/blob/main/CODE_OF_CONDUCT.md).
If you have any concerns about the Code, or behavior which you have experienced in the project, please
contact us at [email protected].
## Security Vulnerability Reporting
Please refer to the project [Security Policy](https://github.com/bloomberg/.github/blob/main/SECURITY.MD).