edgee-api-client 1.2.17

Edgee API client
Documentation

The full-stack edge platform for your edge-oriented applications.

Edgee Docker Edgee Docs Coverage Status

Useful resources

Getting started with the Edgee CLI

The Edgee CLI lets you create and build Wasm components locally with commands such as edgee components new and edgee components build. When 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.

Install the Edgee CLI with your preferred method:

$ curl https://install.edgee.cloud | sh

$ brew tap edgee-cloud/edgee
$ brew install edgee

$ cargo binstall edgee

$ git clone https://github.com/edgee-cloud/edgee.git
$ cd edgee
$ cargo build --release
$ ./target/release/edgee --version

Edgee CLI commands

edgee login

This command lets you log in using your Edgee account's API token (you can create one here):

$ edgee login
Enter Edgee API token (press Ctrl+R to toggle input display): ****

edgee whoami

This command lets you verify that the API is working correctly:

$ edgee whoami
Logged in as:
  ID:    XYZ-XYZ-DYZ
  Name:  Your name
  Email: your@email.com
  Url:   https://api.edgee.app

edgee help

This command lets you get help about existing commands, sub-commands, and their respective options:

$ edgee help
Usage: edgee <COMMAND>
Commands:
  login                      Log in to the Edgee Console
  whoami                     Print currently login informations
  components                 Components management commands [aliases: component]
  serve                      Run the Edgee server [aliases: server]
  self-update                Update the Edgee executable
  generate-shell-completion  Print auto-completion script for your shell init file
  help                       Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

edgee self-update

This command lets you update the CLI to latest, if a new version is available.

Note: this only works if you've installed the CLI via the installation script above.

edgee component[s]

This command includes a few sub-commands that let you create, build, test, and push components.

edgee components new

This command lets you create a component in a new directory (including sample code)

$ edgee components new
? Enter the component name: my-component
? Select a programming language:
  C
  CSharp
  Go
  JavaScript
  Python
> Rust
  TypeScript
 INFO Downloading sample code for Rust...
 INFO Extracting code...
 INFO Downloading WIT files...
 INFO New project my-component is ready! Check README for dependencies.

You can also use command arguments to skip the prompts

$ edgee components new --name foo --language javascript
 INFO Downloading sample code for JavaScript...
 INFO Extracting code...
 INFO Downloading WIT files...
 INFO New project foo is ready! Check README for dependencies.

edgee components build

This command lets you compile the component in the current folder into a WebAssembly binary file.

You can customize the behavior of the build command in the manifest file by changing the target file name and the default build script. If you've created a new component with edgee component new the default build script should be a great starting point. By default, the output of this command will be a new .wasm file in the current folder.

edgee components check

This command lets you validate the local .wasm file to make sure it's compliant with the WIT interface.

Note: this command runs automatically on push.

edgee components test

This command lets you run the local .wasm file with a sample event and provided settings. This helps ensure your component behaves as expected from the proxy's perspective, in addition to your unit tests.

$ edgee components test \
    --event-type page \
    --settings "setting1=value1,setting2=value2"

You can also run the actual HTTP request automatically:

$ edgee components test [options] --make-http-request

Or generate the corresponding cURL command:

$ edgee components test [options] --curl

edgee components push

This command lets you push the local .wasm file to the Edgee Component Registry.

$ edgee components push
 INFO Component org/name does not exists yet!
> Confirm new component creation? Y/n
? Would you like to make this component public or private?
> private
  public
> Describe the new version changelog (optional) [(e) to open nano, (enter) to submit]
> Ready to push org/name@version. Confirm? Y/n
 INFO Uploading Wasm file...
 INFO Creating new version...
 INFO org/name@version pushed successfully!
 INFO URL: https://www.edgee.cloud/~/registry/{organization}/{component}

The push command also lets you publish or unpublish an existing component via --public or --private.

edgee serve

Learn more about running the Edgee proxy locally.

edgee generate-shell-completion

This command allows you to generate a script for your shell adding auto-completion for the edgee command.

$ edgee generate-shell-completion [SHELL]
# supported value: bash, elvish, fish, powershell, zsh

If no argument it passed, the CLI will try to guess it based on the environment.

To install the completions, source them in your shell init file.

# ~/.bashrc
$ eval $(edgee generate-shell-completion bash)

# store the auto-completion in ~/.zsh/_edgee
$ edgee generate-shell-completion zsh > ~/.zsh/_edgee

# ~/.zshrc
fpath=(~/.zsh $fpath)
autoload -Uz compinit
compinit -u
# note: you might need to delete ~/.zcompdump/ first

# ~/.config/fish/completions/edgee.fish
$ edgee generate-shell-completion fish | source

$ edgee generate-shell-completion elvish >> ~/.config/elvish/rc.elv

> edgee generate-shell-completion powershell >> $profile
> .$profile

Contributing

If you're interested in contributing to Edgee, read our contribution guidelines

Reporting Security Vulnerabilities

If you've found a vulnerability or potential vulnerability in our code, please let us know at edgee-security.

Versioning

Edgee releases and their associated binaries are available on the project's releases page.

The binaries are versioned following SemVer conventions.