{"id":21082717,"url":"https://github.com/renproject/nodectl","last_synced_at":"2026-02-18T10:35:12.428Z","repository":{"id":43918847,"uuid":"381548331","full_name":"renproject/nodectl","owner":"renproject","description":"Tool for deploying and managing Darknodes","archived":false,"fork":false,"pushed_at":"2022-07-11T01:51:51.000Z","size":6259,"stargazers_count":2,"open_issues_count":1,"forks_count":2,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-10-19T17:54:14.617Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/renproject.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-30T02:07:28.000Z","updated_at":"2023-01-06T14:42:08.000Z","dependencies_parsed_at":"2022-09-12T07:10:25.320Z","dependency_job_id":null,"html_url":"https://github.com/renproject/nodectl","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/renproject/nodectl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fnodectl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fnodectl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fnodectl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fnodectl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/renproject","download_url":"https://codeload.github.com/renproject/nodectl/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/renproject%2Fnodectl/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29576633,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T08:38:15.585Z","status":"ssl_error","status_checked_at":"2026-02-18T08:38:14.917Z","response_time":162,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":"2024-11-19T20:15:08.104Z","updated_at":"2026-02-18T10:35:07.419Z","avatar_url":"https://github.com/renproject.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nodectl\n\nThe `nodectl` is a command-line interface for managing Darknodes on Ren. It is installed on your local workspace, and will automatically create and update machines for you. Currently it supports **macOS** and **Linux**.\n\n## Installing the tool\n\nTo download and install `nodectl`, open a terminal and run:\n\n```sh\ncurl https://www.github.com/renproject/nodectl/releases/latest/download/install.sh -sSfL | sh\n```\n\nThis will download the required binaries and install them to the `$HOME/.nodectl` directory. Open a new terminal to begin using nodectl.\n\nIf you are using a custom shell, you'll need to manually add it to your `PATH`.\n\n```shell\nexport PATH=$PATH:$HOME/.nodectl/bin\n```\n\n## Updating the tool\n\n**Before updating `nodectl`, please make sure you do not have the tool running in any terminal.**\n\nTo update your `nodectl`, open a terminal and run:\n\n```sh\ncurl https://www.github.com/renproject/nodectl/releases/latest/download/update.sh -sSfL | sh\n```\n\nThis will update your `nodectl` to the latest version without affecting any of your deployed nodes.\n\n\u003e Note: make sure you are using Terraform version \u003e 1.0.0 ! To upgrade Terraform, download the executable for your operating system from https://www.terraform.io/downloads.html and copy it to `$HOME/.nodectl/bin/terraform`.\n\n\n## Usage\n\n### Deploy a Darknode\n\n#### AWS\n\nTo deploy a Darknode on AWS, open a terminal and run:\n\n```sh\nnodectl up --name my-first-darknode --network testnet --aws --aws-access-key YOUR-AWS-ACCESS-KEY --aws-secret-key YOUR-AWS-SECRET-KEY\n``` \n\nThe `nodectl` will automatically use the credentials available at `$HOME/.aws/credentials` if you do not explicitly set the `--access-key` and `--secret-key` arguments.\nBy default, it will use the credentials of `default` profile.\n\nYou can also specify the region and instance type you want to use for the Darknode:\n\n```sh\nnodectl up --name my-first-darknode --network testnet --aws --aws-access-key YOUR-AWS-ACCESS-KEY --aws-secret-key YOUR-AWS-SECRET-KEY --aws-region eu-west-1 --aws-instance t2.small\n``` \nThe default instance type is `t3.micro` and region will be random.\nYou can find all available regions and instance types at [AWS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html).\n\n#### Digital Ocean\n\nYou first need to create an API token.\nTo deploy a Darknode on Digital Ocean, open a terminal and run:\n\n```sh\nnodectl up --name my-first-darknode --network testnet --do --do-token YOUR-API-TOKEN\n``` \n\nYou can also specify the region and droplet size you want to use for the Darknode:\n\n```sh\nnodectl up --name my-first-darknode --network testnet --do --do-token YOUR-API-TOKEN --do-region nyc1 --do-droplet s-2vcpu-2gb\n``` \n\nThe default droplet size is `s-1vcpu-1gb` and region will be random.\nBe aware some region and droplet size are not available to all users.\n\nYou can find all available regions and droplet size slug by using the digital ocean [API](https://developers.digitalocean.com/documentation/v2/#regions).\n\n### Destroy a Darknode\n\n_**WARNING: Before destroying a Darknode make sure you have de-registered it, and withdrawn all fees earned! You will not be able to destroy your darknode if it's not fully deregistered. The CLI will guide you to the page where you can deregister your node**_\n\nDestroying a Darknode will turn it off and tear down all resources allocated by the cloud provider. To destroy a Darknode, open a terminal and run:\n\n```sh\nnodectl destroy my-first-darknode\n``` \n\nTo avoid the command-line prompt confirming the destruction, use the `--force` argument:\n\n```sh\nnodectl destroy --force my-first-darknode \n```\n\nWe do not recommend using the `--force` argument unless you are developing custom tools that manage your Darknodes automatically.\n\n### Get Darknode's peer address\nTo get the Darknode's peer address, open a terminal and run:\n\n```sh\nnodectl address my-first-darknode \n```\nYou can send your Darknode's peer address to others to be included in other Darknode's config files.\n\n### List all Darknodes\n\nThe `nodectl` supports deploying multiple Darknodes. To list all available Darknodes, open a terminal and run:\n\n```sh\nnodectl list\n```\n\n### Start/Stop/Restart Darknode\n\nTo turn off your darknode, open a terminal and run:\n\n```sh\nnodectl stop my-first-darknode\n\n``` \n\nNote this won't shut down the cloud instance, so you will still be charged by your cloud provider.\nIf it is already off, `stop` will do nothing.\n\n\nTo turn on your darknode, open a terminal and run:\n\n```sh\nnodectl start my-first-darknode\n``` \n\nIf it is already on, `start` will do nothing.\n\nTo restart your darknode, open a terminal and run:\n\n```sh\nnodectl restart my-first-darknode\n``` \n\n### SSH into Darknode\n\nTo access your Darknode using SSH, open a terminal and run:\n\n```sh\nnodectl ssh my-first-darknode\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenproject%2Fnodectl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frenproject%2Fnodectl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frenproject%2Fnodectl/lists"}