> For the complete documentation index, see [llms.txt](https://cross-packages.gitbook.io/cross-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cross-packages.gitbook.io/cross-api/introduction.md).

# Introduction

A CLI which can generate a good, clean and statically typed API structure with typescript and SOLID principles. It's features includes CRUD operations, providers, unit tests and documentation.

To install the project:

```
npm install cross-api --save-dev
```

Enter the following code in the terminal to make the initial configuration:

```
npx cross config
```

It will install yarn globally so to see the available commands type:

```
yarn cross help
```

***