{"id":22812201,"url":"https://github.com/edgee-cloud/edgee","last_synced_at":"2026-01-02T19:22:04.751Z","repository":{"id":236309860,"uuid":"792318110","full_name":"edgee-cloud/edgee","owner":"edgee-cloud","description":"The full-stack edge platform for your edge oriented applications.","archived":false,"fork":false,"pushed_at":"2024-10-29T17:05:52.000Z","size":337,"stargazers_count":37,"open_issues_count":9,"forks_count":6,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-10-29T18:32:13.110Z","etag":null,"topics":["data-collection","edge","edge-computing","edgee","http","https","proxy","rust","wasm","wasm-component","webassembly"],"latest_commit_sha":null,"homepage":"https://www.edgee.cloud","language":"Rust","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/edgee-cloud.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-26T12:26:01.000Z","updated_at":"2024-10-28T05:43:14.000Z","dependencies_parsed_at":"2024-08-28T12:26:14.646Z","dependency_job_id":"6da78eae-9c92-4978-a2ad-bb6f7a8d97a5","html_url":"https://github.com/edgee-cloud/edgee","commit_stats":null,"previous_names":["edgee-cloud/edgee"],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edgee-cloud%2Fedgee","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edgee-cloud%2Fedgee/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edgee-cloud%2Fedgee/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edgee-cloud%2Fedgee/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/edgee-cloud","download_url":"https://codeload.github.com/edgee-cloud/edgee/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247194696,"owners_count":20899543,"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":["data-collection","edge","edge-computing","edgee","http","https","proxy","rust","wasm","wasm-component","webassembly"],"created_at":"2024-12-12T12:11:05.872Z","updated_at":"2026-01-02T19:22:04.712Z","avatar_url":"https://github.com/edgee-cloud.png","language":"Rust","readme":"\u003cdiv align=\"center\"\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.edgee.cloud\"\u003e\n    \u003cpicture\u003e\n      \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://cdn.edgee.cloud/img/favicon-dark.svg\"\u003e\n      \u003cimg src=\"https://cdn.edgee.cloud/img/favicon.svg\" height=\"100\" alt=\"Edgee\"\u003e\n    \u003c/picture\u003e\n    \u003ch1 align=\"center\"\u003eEdgee\u003c/h1\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\n**The full-stack edge platform for your edge-oriented applications.**\n\n[![Edgee](https://img.shields.io/badge/edgee-open%20source-blueviolet.svg)](https://www.edgee.cloud)\n[![Docker](https://img.shields.io/docker/v/edgeecloud/edgee.svg?logo=docker\u0026label=docker\u0026color=0db7ed)](https://hub.docker.com/r/edgeecloud/edgee)\n[![Edgee](https://img.shields.io/badge/slack-edgee-blueviolet.svg?logo=slack)](https://www.edgee.cloud/slack)\n[![Docs](https://img.shields.io/badge/docs-published-blue)](https://www.edgee.cloud/docs/introduction)\n[![Coverage Status](https://coveralls.io/repos/github/edgee-cloud/edgee/badge.svg)](https://coveralls.io/github/edgee-cloud/edgee)\n\n\u003c/div\u003e\n\n### Useful resources\n\n- Edgee's\n[Website](https://www.edgee.cloud),\n[Roadmap](https://roadmap.edgee.cloud/roadmap/data-collection-components), and\n[Documentation](https://www.edgee.cloud/docs/introduction)\n- Edgee's [Community Slack](https://www.edgee.cloud/slack)\n- Edgee on [X](https://x.com/edgee_cloud) and [LinkedIn](https://www.linkedin.com/company/edgee-cloud/)\n\n\n## Getting started with the Edgee CLI\n\nThe Edgee CLI lets you create and build Wasm components locally with commands such as `edgee components new` and `edgee components build`.\nWhen your component is ready, the Edgee CLI lets you push it to the Edgee Component Registry as a public or private component under your organization’s account, with `edgee components push`. Under the hood, the CLI interacts with the Edgee API and its goal is to simplify the local development experience across all supported languages.\n\nInstall the Edgee CLI with your preferred method:\n\n\u003cdetails open\u003e\n  \u003csummary\u003eInstall script\u003c/summary\u003e\n\n  ```shell\n  $ curl https://install.edgee.cloud | sh\n  ```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eHomebrew\u003c/summary\u003e\n\n  ```shell\n  $ brew tap edgee-cloud/edgee\n  $ brew install edgee\n  ```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eCargo binstall\u003c/summary\u003e\n\n  ```shell\n  $ cargo binstall edgee\n  ```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eFrom source\u003c/summary\u003e\n\n  ```shell\n  $ git clone https://github.com/edgee-cloud/edgee.git\n  $ cd edgee\n  $ cargo build --release\n  $ ./target/release/edgee --version\n  ```\n\n\u003c/details\u003e\n\n\n## Edgee CLI commands\n\n### `edgee login`\n\nThis command lets you log in using your Edgee account's API token (you can [create one here](https://www.edgee.cloud/~/me/settings/tokens)):\n\n\n```shell\n$ edgee login\nEnter Edgee API token (press Ctrl+R to toggle input display): ****\n```\n\n### `edgee whoami`\n\nThis command lets you verify that the API is working correctly:\n\n```shell\n$ edgee whoami\nLogged in as:\n  ID:    XYZ-XYZ-DYZ\n  Name:  Your name\n  Email: your@email.com\n  Url:   https://api.edgee.app\n```\n\n### `edgee help`\n\nThis command lets you get help about existing commands, sub-commands, and their respective options:\n\n```bash\n$ edgee help\nUsage: edgee \u003cCOMMAND\u003e\nCommands:\n  login                      Log in to the Edgee Console\n  whoami                     Print currently login informations\n  components                 Components management commands [aliases: component]\n  serve                      Run the Edgee server [aliases: server]\n  self-update                Update the Edgee executable\n  generate-shell-completion  Print auto-completion script for your shell init file\n  help                       Print this message or the help of the given subcommand(s)\n\nOptions:\n  -h, --help     Print help\n  -V, --version  Print version\n```\n\n### `edgee self-update`\n\nThis command lets you update the CLI to latest, if a new version is available.\n\nNote: this only works if you've installed the CLI via the installation script above.\n\n### `edgee component[s]`\n\nThis command includes a few sub-commands that let you create, build, test, and push components.\n\n#### `edgee components new`\n\nThis command lets you create a component in a new directory (including sample code)\n\n```bash\n$ edgee components new\n? Enter the component name: my-component\n? Select a programming language:\n  C\n  CSharp\n  Go\n  JavaScript\n  Python\n\u003e Rust\n  TypeScript\n INFO Downloading sample code for Rust...\n INFO Extracting code...\n INFO Downloading WIT files...\n INFO New project my-component is ready! Check README for dependencies.\n```\n\nYou can also use command arguments to skip the prompts\n\n```bash\n$ edgee components new --name foo --language javascript\n INFO Downloading sample code for JavaScript...\n INFO Extracting code...\n INFO Downloading WIT files...\n INFO New project foo is ready! Check README for dependencies.\n```\n\n#### `edgee components build`\n\nThis command lets you compile the component in the current folder into a WebAssembly binary file.\n\nYou can customize the behavior of the build command in the\n[manifest file](https://www.edgee.cloud/docs/services/registry/developer-guide#component-manifest-file)\nby changing the target file name\nand the default build script. If you've created a new component with `edgee component new` the default build script\nshould be a great starting point. By default, the output of this command will be a new .wasm file in the current folder.\n\n\n#### `edgee components check`\n\nThis command lets you validate the local .wasm file to make sure it's compliant with the WIT interface.\n\nNote: this command runs automatically on push.\n\n#### `edgee components test`\n\nThis command lets you run the local .wasm file with a sample event and provided settings.\nThis helps ensure your component behaves as expected from the proxy's perspective, in addition to your unit tests.\n\n```bash\n$ edgee components test \\\n    --event-type page \\\n    --settings \"setting1=value1,setting2=value2\"\n```\n\nYou can also run the actual HTTP request automatically:\n\n```bash\n$ edgee components test [options] --make-http-request\n\n```\n\nOr generate the corresponding cURL command:\n\n```bash\n$ edgee components test [options] --curl\n```\n\n#### `edgee components push`\n\nThis command lets you push the local .wasm file to the Edgee Component Registry.\n\n```shell\n$ edgee components push\n INFO Component org/name does not exists yet!\n\u003e Confirm new component creation? Y/n\n? Would you like to make this component public or private?\n\u003e private\n  public\n\u003e Describe the new version changelog (optional) [(e) to open nano, (enter) to submit]\n\u003e Ready to push org/name@version. Confirm? Y/n\n INFO Uploading Wasm file...\n INFO Creating new version...\n INFO org/name@version pushed successfully!\n INFO URL: https://www.edgee.cloud/~/registry/{organization}/{component}\n```\n\nThe push command also lets you publish or unpublish an existing component via `--public` or `--private`.\n\n### `edgee serve`\n\nLearn more about [running the Edgee proxy locally](./README-proxy.md).\n\n### `edgee generate-shell-completion`\n\nThis command allows you to generate a script for your shell adding auto-completion for the `edgee` command.\n\n```shell\n$ edgee generate-shell-completion [SHELL]\n# supported value: bash, elvish, fish, powershell, zsh\n```\n\nIf no argument it passed, the CLI will try to guess it based on the environment.\n\nTo install the completions, source them in your shell init file.\n\n\u003cdetails\u003e\n  \u003csummary\u003ebash\u003c/summary\u003e\n\n  ```shell\n  # ~/.bashrc\n  $ eval $(edgee generate-shell-completion bash)\n  ```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003ezsh\u003c/summary\u003e\n\n  ```shell\n  # store the auto-completion in ~/.zsh/_edgee\n  $ edgee generate-shell-completion zsh \u003e ~/.zsh/_edgee\n\n  # ~/.zshrc\n  fpath=(~/.zsh $fpath)\n  autoload -Uz compinit\n  compinit -u\n  # note: you might need to delete ~/.zcompdump/ first\n  ```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003efish\u003c/summary\u003e\n\n  ```shell\n  # ~/.config/fish/completions/edgee.fish\n  $ edgee generate-shell-completion fish | source\n  ```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eelvish\u003c/summary\u003e\n\n  ```shell\n  $ edgee generate-shell-completion elvish \u003e\u003e ~/.config/elvish/rc.elv\n  ```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003epowershell\u003c/summary\u003e\n\n  ```shell\n  \u003e edgee generate-shell-completion powershell \u003e\u003e $profile\n  \u003e .$profile\n  ```\n\n\u003c/details\u003e\n\n## Contributing\nIf you're interested in contributing to Edgee, read our [contribution guidelines](./CONTRIBUTING.md)\n\n## Reporting Security Vulnerabilities\nIf you've found a vulnerability or potential vulnerability in our code, please let us know at\n[edgee-security](mailto:security@edgee.cloud).\n\n## Versioning\nEdgee releases and their associated binaries are available on the project's [releases page](https://github.com/edgee-cloud/edgee/releases).\n\nThe binaries are versioned following [SemVer](https://semver.org/) conventions.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedgee-cloud%2Fedgee","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedgee-cloud%2Fedgee","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedgee-cloud%2Fedgee/lists"}