{"id":26426651,"url":"https://github.com/opensvm/osvm-cli","last_synced_at":"2025-03-18T03:34:29.449Z","repository":{"id":281108277,"uuid":"931353235","full_name":"openSVM/osvm-cli","owner":"openSVM","description":"Open SVM cli, interact with any SVM with ease","archived":false,"fork":false,"pushed_at":"2025-03-16T13:58:43.000Z","size":1663,"stargazers_count":3,"open_issues_count":5,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-03-16T14:35:00.548Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openSVM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-12T06:07:49.000Z","updated_at":"2025-03-13T01:12:59.000Z","dependencies_parsed_at":"2025-03-07T03:22:55.993Z","dependency_job_id":"7f129258-075b-4043-9272-828a6acac69d","html_url":"https://github.com/openSVM/osvm-cli","commit_stats":null,"previous_names":["opensvm/osvm-cli"],"tags_count":2,"template":false,"template_full_name":"hashblock/solana-cli-program-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openSVM%2Fosvm-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openSVM%2Fosvm-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openSVM%2Fosvm-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openSVM%2Fosvm-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openSVM","download_url":"https://codeload.github.com/openSVM/osvm-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244152502,"owners_count":20406992,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-18T03:34:28.380Z","updated_at":"2025-03-18T03:34:29.437Z","avatar_url":"https://github.com/openSVM.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OSVM CLI 🚀\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)\n[![Rust](https://img.shields.io/badge/Rust-1.80.0+-orange.svg)](https://www.rust-lang.org/)\n[![Solana](https://img.shields.io/badge/Solana-1.14.29+-purple.svg)](https://solana.com/)\n\nA powerful command-line interface for managing Solana Virtual Machines (SVMs) across various networks. Monitor, deploy, and manage your SVM infrastructure with a single tool.\n\n```mermaid\ngraph TB\n    User((User))\n\n    subgraph \"OSVM CLI System\"\n        subgraph \"CLI Interface\"\n            MainCLI[\"Main CLI\u003cbr\u003eRust/Clap\"]\n            CommandParser[\"Command Parser\u003cbr\u003eClap\"]\n            \n            subgraph \"Core Commands\"\n                SVMCommands[\"SVM Commands\u003cbr\u003eRust\"]\n                NodeCommands[\"Node Commands\u003cbr\u003eRust\"]\n                SolanaCommands[\"Solana Commands\u003cbr\u003eRust\"]\n                RPCCommands[\"RPC Commands\u003cbr\u003eRust\"]\n            end\n        end\n        \n        subgraph \"Node Management\"\n            NodeManager[\"Node Manager\u003cbr\u003eRust\"]\n            \n            subgraph \"Node Components\"\n                NodeDB[\"Node Database\u003cbr\u003eJSON\"]\n                NodeMonitor[\"Node Monitor\u003cbr\u003eRust\"]\n                NodeDashboard[\"Node Dashboard\u003cbr\u003eRatatui\"]\n                NodeMetrics[\"Node Metrics\u003cbr\u003eRust\"]\n                NodeLogs[\"Log Manager\u003cbr\u003eRust\"]\n            end\n        end\n        \n        subgraph \"SSH Deployment\"\n            SSHManager[\"SSH Manager\u003cbr\u003eSSH2\"]\n            \n            subgraph \"Deployment Components\"\n                DeployConfig[\"Deployment Config\u003cbr\u003eRust\"]\n                DiskManager[\"Disk Manager\u003cbr\u003eRust\"]\n                ServiceManager[\"Service Manager\u003cbr\u003eRust\"]\n                HotSwap[\"Hot Swap Manager\u003cbr\u003eRust\"]\n                Dependencies[\"Dependency Manager\u003cbr\u003eRust\"]\n            end\n        end\n        \n        subgraph \"Utilities\"\n            Logger[\"Logger\u003cbr\u003eenv_logger\"]\n            Config[\"Config Manager\u003cbr\u003eYAML\"]\n            Dashboard[\"Dashboard Generator\u003cbr\u003eHTML/CSS\"]\n            Examples[\"Examples Manager\u003cbr\u003eRust\"]\n        end\n    end\n\n    subgraph \"External Systems\"\n        SolanaNode[\"Solana Node\u003cbr\u003eRust\"]\n        RPCNode[\"RPC Node\u003cbr\u003eJSON-RPC\"]\n        RemoteServer[\"Remote Server\u003cbr\u003eLinux\"]\n    end\n\n    User --\u003e|Uses| MainCLI\n    MainCLI --\u003e|Parses| CommandParser\n    CommandParser --\u003e|Executes| SVMCommands\n    CommandParser --\u003e|Executes| NodeCommands\n    CommandParser --\u003e|Executes| SolanaCommands\n    CommandParser --\u003e|Executes| RPCCommands\n\n    NodeCommands --\u003e|Manages| NodeManager\n    NodeManager --\u003e|Stores| NodeDB\n    NodeManager --\u003e|Monitors| NodeMonitor\n    NodeMonitor --\u003e|Displays| NodeDashboard\n    NodeMonitor --\u003e|Collects| NodeMetrics\n    NodeManager --\u003e|Manages| NodeLogs\n\n    SolanaCommands --\u003e|Deploys| SSHManager\n    RPCCommands --\u003e|Deploys| SSHManager\n    SSHManager --\u003e|Uses| DeployConfig\n    SSHManager --\u003e|Manages| DiskManager\n    SSHManager --\u003e|Controls| ServiceManager\n    SSHManager --\u003e|Handles| HotSwap\n    SSHManager --\u003e|Installs| Dependencies\n\n    MainCLI --\u003e|Uses| Logger\n    MainCLI --\u003e|Reads| Config\n    NodeDashboard --\u003e|Generates| Dashboard\n    MainCLI --\u003e|Shows| Examples\n\n    SSHManager --\u003e|Connects to| RemoteServer\n    NodeMonitor --\u003e|Monitors| SolanaNode\n    NodeMonitor --\u003e|Monitors| RPCNode\n```\n\n## ⚡ One-Line Installation\n\n### Linux/macOS\n\n```bash\ncurl -sSf https://raw.githubusercontent.com/opensvm/osvm-cli/main/install.sh | sh\n```\n\n### Windows\n\n```bash\npowershell -Command \"Invoke-WebRequest -Uri 'https://raw.githubusercontent.com/opensvm/osvm-cli/main/install.ps1' -OutFile 'install.ps1'; .\\install.ps1\"\n```\n\n## 🌟 Key Features\n\n- **SVM Management**: List and inspect Solana Virtual Machines\n- **Node Deployment**: Deploy validator or dedicated RPC nodes with a single command\n- **Interactive Dashboard**: Real-time monitoring with a terminal-based UI\n- **Network Configuration**: Configure nodes for mainnet, testnet, or devnet\n- **Performance Metrics**: Track TPS, latency, and system requirements\n- **Colorized Output**: Enhanced readability with consistent color-coding for status, commands, and data\n- **Command Examples**: Built-in examples for common workflows and operations\n- **SSH Deployment**: Remote deployment and management capabilities\n\n## 📋 Command Reference\n\n### SVM Management\n\n```bash\n# List all SVMs installed in the chain\nosvm svm list\n\n# Get detailed information about a specific SVM\nosvm svm get sonic\n\n# Launch interactive dashboard\nosvm svm dashboard\n```\n\n### Command Examples and Help\n\n```bash\n# Show examples for all command categories\nosvm examples\n\n# Show examples for a specific category\nosvm examples --category svm\n\n# Available categories: basic, svm, node, monitoring, workflow\n\n# List all available example categories\nosvm examples --list-categories\n```\n\n### Node Deployment\n\n```bash\n# Deploy a validator node to a remote server (mainnet)\nosvm user@host --svm sonic --node-type validator --network mainnet\n\n# Deploy an RPC node to a remote server (testnet)\nosvm user@host --svm sonic --node-type rpc --network testnet\n\n# Deploy a Sonic RPC node to a remote server\nosvm rpc sonic root@host.example.com --network mainnet\n\n# Deploy multiple SVMs to a single server\nosvm user@host --svm sonic,solana,sei --node-type validator --network devnet\n```\n\n### RPC Node Deployment\n\n```bash\n# Deploy a Sonic RPC node to a remote server (mainnet)\nosvm rpc sonic user@host --network mainnet\n\n# Deploy a Sonic RPC node to a remote server (testnet)\nosvm rpc sonic user@host --network testnet\n\n# Deploy a Sonic RPC node to a remote server (devnet)\nosvm rpc sonic user@host --network devnet\n```\n\nThe `rpc` command provides a streamlined way to deploy specific RPC nodes:\n\n- **Sonic RPC**: Deploys a Sonic RPC node using Docker containers from the official repository\n- **Network Selection**: Choose between mainnet, testnet, or devnet environments\n- **Automatic Configuration**: Handles all dependencies and configuration automatically\n\n## 🔧 Detailed Installation\n\n### Prerequisites\n\n- Rust 1.80.0 or later\n- Solana CLI tools 1.14.29 or later\n\n### From Source\n\n```bash\n# Clone the repository\ngit clone https://github.com/opensvm/osvm-cli.git\ncd osvm-cli\n\n# Build the project\ncargo build --release\n\n# Install the binary\nsudo cp target/release/osvm /usr/local/bin/\n```\n\n## 📊 Dashboard Features\n\nThe interactive dashboard provides real-time monitoring of your SVM infrastructure, including:\n\n- Overview of all installed SVMs with status indicators\n- Network details for each SVM (mainnet, testnet, devnet)\n- Performance metrics with real-time visualization\n- Node status monitoring with resource usage\n- Aggregated logs from all nodes\n\nLaunch the dashboard with:\n\n```bash\nosvm svm dashboard\n```\n\n### Keyboard Controls\n\n- `Tab`, `Right Arrow`, `Left Arrow`: Switch between tabs\n- `Up Arrow`, `Down Arrow`: Navigate through items\n- `n`: Select next SVM\n- `v`: Toggle verbosity level (affects displayed information detail)\n- `p`: Select previous SVM\n- `h`: Toggle help overlay\n- `q` or `Ctrl+C`: Quit the dashboard\n\n## 📚 Documentation\n\nFor complete documentation, visit [our official documentation](https://docs.opensvm.org).\n\n## 🤝 Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensvm%2Fosvm-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopensvm%2Fosvm-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopensvm%2Fosvm-cli/lists"}