Get started

Ship the app

edge build packs the project and every package it declares into one artifact. edge publish sends that artifact to the registry, where anyone can add it with edge add.

Name the package

The registry reads the name and the version from the manifest inside the artifact. Add them to edge.json with a one line description.

{
  "name": "words",
  "version": "0.1.0",
  "description": "Count the words of a text and rank them.",
  "edge": "0.9.4",
  "imports": {
    "json": "0.1.0",
    "test": "0.1.1"
  }
}

A name is first come and permanent. Pick one nobody holds yet. Package fields lists the rules for each field.

Build it

$ edge build

  packed app.edge (6 files)
  114.27 KB

  run  edge run app.edge   or send it to an actor eval group

app.edge holds the code, the manifest, the lock and both packages. It runs on any machine with edge installed.

Two other modes target other places.

• edge build --app writes app, a standalone binary that runs offline on the same OS and CPU with nothing installed.
• edge build --web writes dist/, a folder any browser runs, with the JS host and every package beside it.

edge build covers the three modes and their flags.

Publish it

1. Create a token in the settings.
2. Export it as EDGE_TOKEN in your shell.
3. Run edge publish on the artifact.

$ export EDGE_TOKEN=edge_pat_...
$ edge publish app.edge
  published words 0.1.0

  add it with  edge add words
  https://cdn.edgepython.com/pkg/words/0.1.0/app.edge

The token signs the request and never leaves your machine. The registry reads the listing out of the artifact itself.

Next steps