Welcome to puter-sdk !

[bitsnaps]

👋 Welcome to Puter-SDK!

Hello everyone,

We wanted to share the story and vision behind the puter-cli and puter-sdk projects to give the community a clear understanding of our goals and how you can get involved.

The Journey

The puter-cli project began as a lightweight tool to help manage common tasks within Puter directly from the command line. What started with basic app and site management quickly expanded to include file operations, key-value store interactions, and more, evolving into a comprehensive CLI for the Puter platform.

As its capabilities grew, we recognized the potential for even broader applications, including advanced automation and CI/CD integrations. This required a more structured, robust, and maintainable foundation than a simple CLI could provide.

Next step > Solid foundation

This led to the decision to decouple the core API logic from the command-line interface. The goal is to create a stable, well-tested, and reusable library that can power not just the CLI, but any Node.js project that needs to interact with Puter.

This is where the puter-sdk comes in.

The puter-sdk is designed from the ground up to be a solid foundation for Puter development. Our focus for the SDK is on:

• Robustness and Stability: High-quality code with extensive test coverage.
• Excellent Documentation: A clear and easy-to-follow API that is aligned with the official Puter API specifications.
• Portability: A library that is easy to integrate into any Node.js environment, from simple scripts to complex backend applications.

The Roadmap Ahead

The puter-sdk will become the engine that powers the next generation of our tools. The roadmap is as follows:

1. Develop puter-sdk: Our primary focus is on building and stabilizing the SDK to serve as the main interface for the Puter API.
2. Rebuild puter-cli: A future version (v2.x) of puter-cli will be rebuilt entirely on top of the puter-sdk.

This approach will ensure a single, maintainable codebase for all API interactions, making both projects more reliable and easier to develop for and debug.

How to contribute

This is a community effort, and we welcome your contributions. We are actively designing powerful new feature, and your input is valuable. Whether it's through code, documentation, feature suggestions, or feedback on the SDK's design, your involvement will help shape the future of these tools.

Thank you for being a part of this journey.