{"id":18666761,"url":"https://github.com/paralus/cli","last_synced_at":"2025-04-11T23:33:11.889Z","repository":{"id":40640841,"uuid":"465281038","full_name":"paralus/cli","owner":"paralus","description":"Command Line Interface tool for Paralus","archived":false,"fork":false,"pushed_at":"2024-11-11T15:44:34.000Z","size":14184,"stargazers_count":8,"open_issues_count":9,"forks_count":12,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-25T19:53:16.313Z","etag":null,"topics":["cli","cli-for-paralus","command-line-interface","hacktoberfest","hacktoberfest2023"],"latest_commit_sha":null,"homepage":"https://www.paralus.io/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/paralus.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-02T11:40:36.000Z","updated_at":"2024-07-25T05:29:45.000Z","dependencies_parsed_at":"2024-06-19T16:24:35.533Z","dependency_job_id":"a8ab34e4-ffe1-4f13-a7ea-d9e4cf56f676","html_url":"https://github.com/paralus/cli","commit_stats":{"total_commits":70,"total_committers":14,"mean_commits":5.0,"dds":0.7857142857142857,"last_synced_commit":"b63cc9533ccb4b61660486ca967241c4a25a0985"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paralus%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paralus%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paralus%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/paralus%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/paralus","download_url":"https://codeload.github.com/paralus/cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248495811,"owners_count":21113703,"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":["cli","cli-for-paralus","command-line-interface","hacktoberfest","hacktoberfest2023"],"created_at":"2024-11-07T08:33:59.359Z","updated_at":"2025-04-11T23:33:06.874Z","avatar_url":"https://github.com/paralus.png","language":"Go","readme":"# Paralus cli\n\nCLI tool to interact with Paralus.\n\n## Usage\n\n[Download](https://github.com/paralus/cli/releases) the latest CLI binary and add it to your PATH.\n\n`export PATH=$PATH:/usr/local/bin/pctl`\n\nYou can download the config using below command (RECOMMENDED)\n\n```\npctl config download http://console.paralus.local\nEnter Email: admin@paralus.local\nEnter Password: \nCLI config stored at `/home/.paralus/cli/config.json`\n```\n\nOR \n\nDownload the config from Paralus dashboard (*My Tools -\u003e Download CLI Config*), this should be placed in the default directory under `$HOME/.paralus/cli`. *Create the directory if it doesn't exist.*\n\nSample configuration file looks like below:\n\n```json\n{\n    \"profile\": \"dev\",\n    \"rest_endpoint\": \"console-ic-oss.dev.paralus-edge.net\",\n    \"ops_endpoint\": \"console-ic-oss.dev.paralus-edge.net\",\n    \"api_key\": \"9cfa2b7e009032dd1cd070fff811d59560a5ba28\",\n    \"api_secret\": \"76f60059a2b6a97535da1394b57fe520c709e4c7f877ce4a4bd665924f6ced11\",\n    \"project\": \"default\",\n    \"organization\": \"exampleorg\",\n    \"partner\": \"example\"\n}\n```\n\n## Features\n\nThe CLI allows you an additional way to interact with Paralus. There are commands that you can use to perform certain tasks, for example:\n\n- `pctl create p project --desc \"Description of the project\"` to create a project\n- `pctl create cluster imported sample-imported-cluster` to import a cluster\n- `pctl get users` to list all users\n\nFor a complete list of commands, refer to our [CLI documentation](https://www.paralus.io/docs/usage/cli).\n\n## Community \u0026 Support\n\n- Visit [Paralus website](https://paralus.io) for the complete documentation and helpful links.\n- Join our [Slack channel](https://join.slack.com/t/paralus/shared_invite/zt-1a9x6y729-ySmAq~I3tjclEG7nDoXB0A) to post your queries and discuss features.\n- Tweet to [@paralus_](https://twitter.com/paralus_/) on Twitter.\n- Create [GitHub Issues](https://github.com/paralus/cli/issues) to report bugs or request features.\n\n## Contributing\n\nThe easiest way to start is to look at existing issues and see if there’s something there that you’d like to work on. You can filter issues with the label “Good first issue” which are relatively self sufficient issues and great for first time contributors.\n\nOnce you decide on an issue, please comment on it so that all of us know that you’re on it.\n\nIf you’re looking to add a new feature, raise a [new issue](https://github.com/paralus/cli/issues) and start a discussion with the community. Engage with the maintainers of the project and work your way through.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparalus%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fparalus%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fparalus%2Fcli/lists"}