@theneo/cli

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
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• 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

@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

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:

   git clone https://github.com/Theneo-Inc/theneo-tools.git
   cd theneo-tools

2. Install cli from the repository

   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.