Welcome to the Perch repository! Perch is a developer-friendly command-line tool designed for scaffolding and managing MCP HexLayer Architecture server projects. This tool streamlines your workflow and enhances your development experience.
- Developer-Friendly: Designed with developers in mind, Perch simplifies the setup of your projects.
- MCP HexLayer Architecture: Built specifically for the HexLayer Architecture, it supports modular design and separation of concerns.
- Fast Setup: Quickly scaffold new projects and get started without unnecessary delays.
- Streamable HTTP: Easily manage HTTP requests and responses in a clean and efficient manner.
- Modular Design: Leverage the power of modular programming to create maintainable and scalable applications.
- Python-Based: Built using Python, ensuring compatibility and ease of use for Python developers.
To install Perch, you can download the latest release from the Releases section. Make sure to download the appropriate file for your system, then execute it to set up Perch on your machine.
# Example command to install Perch
pip install perch-pyUsing Perch is straightforward. Once installed, you can access the command line interface to start creating and managing your projects.
Here are some basic commands to get you started:
perch create <project-name>
perch manage <project-name>When you create a new project, Perch will scaffold a clean architecture for you. This includes directories for models, views, and controllers, making it easy to organize your code.
<project-name>/
│
├── models/
│ └── __init__.py
├── views/
│ └── __init__.py
├── controllers/
│ └── __init__.py
└── main.py
Perch offers a variety of commands to help you manage your projects effectively. Here are some of the key commands:
perch create <project-name>This command creates a new project with the specified name.
perch manage <project-name>Use this command to manage an existing project. This includes running the server, updating dependencies, and more.
For a full list of commands and options, please refer to the documentation or use the help command:
perch --helpWe welcome contributions to Perch! If you would like to contribute, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with clear messages.
- Push your changes to your forked repository.
- Submit a pull request.
Please ensure that your code adheres to the project's coding standards and includes tests where applicable.
Perch is licensed under the MIT License. See the LICENSE file for more details.
If you encounter any issues or have questions, feel free to check the Releases section for updates or reach out through the repository's issues page.
Thank you for using Perch! We hope it makes your development process smoother and more efficient.