{"id":18458458,"url":"https://github.com/relaycorp/awala-ping-desktop","last_synced_at":"2026-02-10T11:35:23.897Z","repository":{"id":38353619,"uuid":"172229244","full_name":"relaycorp/awala-ping-desktop","owner":"relaycorp","description":"Awala Ping for Desktop","archived":false,"fork":false,"pushed_at":"2024-06-18T07:17:56.000Z","size":2080,"stargazers_count":1,"open_issues_count":10,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-27T00:46:49.682Z","etag":null,"topics":["awala","awala-service-ping","linux","macos","windows"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@relaycorp/awala-ping","language":"TypeScript","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/relaycorp.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-02-23T15:20:46.000Z","updated_at":"2023-07-13T09:28:19.000Z","dependencies_parsed_at":"2024-03-17T01:22:46.132Z","dependency_job_id":"6e4c4b6b-47b3-4987-8def-40fdcb4e4a90","html_url":"https://github.com/relaycorp/awala-ping-desktop","commit_stats":{"total_commits":222,"total_committers":2,"mean_commits":111.0,"dds":0.2072072072072072,"last_synced_commit":"365a62397c17af998dacd2d1cd47ad7d27221f5c"},"previous_names":[],"tags_count":111,"template":false,"template_full_name":null,"purl":"pkg:github/relaycorp/awala-ping-desktop","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relaycorp%2Fawala-ping-desktop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relaycorp%2Fawala-ping-desktop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relaycorp%2Fawala-ping-desktop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relaycorp%2Fawala-ping-desktop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/relaycorp","download_url":"https://codeload.github.com/relaycorp/awala-ping-desktop/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relaycorp%2Fawala-ping-desktop/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267038420,"owners_count":24025612,"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","status":"online","status_checked_at":"2025-07-25T02:00:09.625Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["awala","awala-service-ping","linux","macos","windows"],"created_at":"2024-11-06T08:18:40.601Z","updated_at":"2026-02-10T11:35:23.828Z","avatar_url":"https://github.com/relaycorp.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"./ping-logo.png\" align=\"right\" alt=\"Awala Ping logo\"/\u003e\n\n# Awala Ping for Desktop\n\nThe Awala Ping for Desktop is a CLI implementation of the [Awala Ping Service](https://specs.awala.network/RS-014), which is meant to help test Awala itself.\n\nThis document is aimed at advanced users and (prospective) contributors. To learn more about using Awala in general, visit [awala.network/users](https://awala.network/users).\n\n## Install\n\nThis tool is available as [the NPM package `@relaycorp/awala-ping`](https://www.npmjs.com/package/@relaycorp/awala-ping). To install it globally, run:\n\n```shell\nnpm install -g @relaycorp/awala-ping\n```\n\n## Use\n\n### Sending pings\n\nTo send a ping, run:\n\n```\nawala-ping ping\n```\n\nThe command above will wait until the pong message is received.\n\n### Sending pings to custom endpoints\n\nBy default, the `ping` subcommand will communicate with the public endpoint at `ping.awala.services`. If you wish to use a different endpoint, you need to:\n\n1. Download the identity certificate for the public endpoint with which you want to communicate.\n1. Import the endpoint first with the `third-party-endpoints import-public` subcommand. For example:\n   ```shell\n   awala-ping third-party-endpoints import-public \u003c /path/to/connection-params.der\n   ```\n1. Specify the Internet address of your custom endpoint when you send pings. For example:\n   ```shell\n   awala-ping ping your-endpoint.com\n   ```\n\n### Registering with the private gateway\n\nBy default, the `ping` subcommand will register with the [Awala Gateway for Desktop](https://github.com/relaycorp/awala-gateway-desktop) if the app hasn't been registered yet. To register explicitly, run:\n\n```\nawala-ping register\n```\n\nEach registration will create an Awala endpoint internally. The latest endpoint to be created will become the default one.\n\n## Security and privacy considerations\n\nThe items below summarize the security and privacy considerations specific to this app. For a more general overview of the security considerations in Awala, please refer to [RS-019](https://specs.awala.network/RS-019).\n\n### No personally-identifiable information is stored\n\nThis app only stores cryptographically-generated data whose inputs are not derived in any way from personally-identifiable information.\n\n### External communication\n\nThis app only communicates with the following:\n\n- The [private gateway](https://github.com/relaycorp/awala-gateway-desktop).\n- Any public endpoint that the user sends pings to. By default, the Relaycorp-operated public endpoint at `ping.awala.services` is used.\n\nThis app doesn't track usage (for example, using Google Analytics), nor does it use ads.\n\n## Development\n\nTo install this app in development, simply run `npm install` from the root of the repository.\n\nTo run a subcommand in the CLI, pass the subcommand name to the command `npm run run --`. For example, to send a ping, run:\n\n```shell\nnpm run run -- ping\n```\n\n## Contributing\n\nWe love contributions! If you haven't contributed to a Relaycorp project before, please take a minute to [read our guidelines](https://github.com/relaycorp/.github/blob/master/CONTRIBUTING.md) first.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelaycorp%2Fawala-ping-desktop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frelaycorp%2Fawala-ping-desktop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelaycorp%2Fawala-ping-desktop/lists"}