pipeops-cli

README

PipeOps CLI 🚀

PipeOps CLI is a powerful command-line interface designed to simplify managing cloud-native environments, deploying projects, and interacting with the PipeOps platform. With PipeOps CLI, you can provision servers, deploy applications, manage projects, and monitor your infrastructure seamlessly.

---

Features ✨

• Server Management: Provision and configure servers across multiple environments (e.g., K3s, EKS, GKE).
• Project Deployment: Deploy your applications directly to servers with ease.
• Pipeline Management: Create, manage, and deploy CI/CD pipelines.
• Agent Setup: Install and configure PipeOps agents for various platforms.
• Authentication: Securely log in and manage your PipeOps account.
• Cross-Platform Support: Available for Linux, Windows, and macOS.

---

Installation 📦

Download the latest version from the Releases page or use the following commands:

Linux / macOS

curl -LO https://github.com/PipeOpsHQ/pipeops-cli/releases/latest/download/pipeops-cli-linux-amd64
chmod +x pipeops-cli-linux-amd64
sudo mv pipeops-cli-linux-amd64 /usr/local/bin/pipeops

Windows

1. Download pipeops-cli-windows-amd64.exe from the Releases.
2. Add it to your PATH for easier access.

---

Quick Start 🚀

Authenticate with PipeOps

pipeops auth login

Deploy a Server

pipeops server deploy --name my-server --region us-east

Deploy a Project to a Server

pipeops project deploy --name my-project --server my-server

List Projects

pipeops project list

For a complete list of commands, use:

pipeops help

---

Commands Overview 📖

Command	Description
pipeops auth	Manage authentication and user details.
pipeops server	Manage server-related operations (e.g., K3s).
pipeops project	Manage, list, and deploy PipeOps projects.
pipeops deploy	Manage and deploy CI/CD pipelines.

---

Development 🛠️

Prerequisites

• Go 1.20 or later
• Git

Clone the Repository

git clone https://github.com/PipeOpsHQ/pipeops-cli.git
cd pipeops-cli

Build the CLI

go build -o pipeops

Run Tests

go test ./...

---

Contributing 🤝

We welcome contributions! To contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/my-feature).
3. Commit your changes (git commit -m 'Add my feature').
4. Push to the branch (git push origin feature/my-feature).
5. Open a Pull Request.

Please follow our Code of Conduct and review our Contributing Guidelines.

---

License 📜

This project is licensed under the MIT License.

---

Support 💬

For questions or support, please open an issue or contact us at support@pipeops.io.

---

Acknowledgments 🙌

Special thanks to all contributors and users of PipeOps CLI! 🎉

Documentation

Overview

Copyright © 2024 9trocode

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.