https://github.com/Theneo-Inc/theneo-tools
Theneo CLI & Theneo SDK
https://github.com/Theneo-Inc/theneo-tools
api cli docs sdk theneo turborepo
Last synced: 9 months ago
JSON representation
Theneo CLI & Theneo SDK
- Host: GitHub
- URL: https://github.com/Theneo-Inc/theneo-tools
- Owner: Theneo-Inc
- License: mit
- Created: 2023-09-20T23:17:16.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T13:47:52.000Z (almost 2 years ago)
- Last Synced: 2024-09-10T09:21:19.815Z (almost 2 years ago)
- Topics: api, cli, docs, sdk, theneo, turborepo
- Language: TypeScript
- Homepage: https://app.theneo.io/theneo/quickstart/theneo-developer-tools
- Size: 838 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Theneo Tools
This is a monorepo project that houses two packages: `@theneo/cli` and `@theneo/sdk`. The project is managed using
TurboRepo to streamline development and management of these packages.
## Table of Contents
- [Packages](#packages)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Packages
### @theneo/cli
`@theneo/cli` is a command-line tool for effortless management of the Theneo platform from your terminal.
Create, manage, and publish API documentation with ease, all without leaving your command line.
For more, see [this](packages/theneo-cli/README.md)
### @theneo/sdk
`@theneo/sdk` is an SDK package that simplifies making API requests to Theneo API. Easily integrate Theneo's features
into your applications, abstracting away the complexities of API requests and error handling.
For more, see [this](packages/theneo-sdk/README.md)
## Getting Started
### Prerequisites
Before you begin, ensure you have met the following requirements:
- Node.js >= 18.x and npm installed
### Installation
1. Clone this repository:
```shell
git clone https://github.com/Theneo-Inc/theneo-tools.git
cd theneo-tools
```
2. Install cli from the repository
```shell
npm run cli
```
### Usage
Describe how to use your packages here. Provide examples and instructions for using @theneo/cli and @theneo/sdk.
### Contributing
We welcome contributions from the community. To contribute to this project, please follow these steps:
1. Fork this repository.
2. Create a new branch with a descriptive name.
3. Make your changes and commit them.
4. Push your changes to your fork.
5. Submit a pull request to the main repository.
6. Please ensure your code adheres to our coding guidelines and includes appropriate tests and documentation.
# License
This project is licensed under the MIT License - see the LICENSE.md file for details.