Azion CLI link

Azion CLI command that sets up an existing project folder for Azion with a preset, with every flag, its type, and its default.

Last updated

View as Markdown Agent setup

The Azion CLI link command sets up the project in the current directory so that the CLI can build, run, and deploy it as an Application. It writes the azion/azion.json file and an azion.config file for the preset you choose, and it can add entries to .gitignore and a GitHub Actions workflow. The command creates no resource on Azion: every ID in azion/azion.json stays 0 until the first deploy. The options every command accepts, such as --format, --out, and -y, are on Global options.

Usage

Run azion link from the root folder of the project:

azion link [flags]
FlagShortTypeDefaultDescription
--auto———Runs the whole command without stopping for a question. It adds the .gitignore entries and the GitHub Actions workflow, and it does not build or deploy the project.
--config-dir—string"azion"Relative path to the folder that holds your azion.json and args.json files.
--local———Runs the build and the deploy on your machine when you deploy the project from this command.
--name—string—Name of the application. Without it, the command suggests a random name and asks you to accept it or type another.
--package-manager—string—Package manager to use, such as npm, yarn, or pnpm.
--preset—string—Preset the project builds with, such as html or next. The names are the ones Azion CLI presets lists. Without it, the command opens a picker with the same names.
--remote—string—URL of a Git repository to clone and link to an application.
--skip-framework-build———Skips the framework build that runs before azion build.
--sync———Synchronizes the local azion.json file with the remote resources when you deploy the project from this command.

For a static HTML site, use the html preset. A project linked with html serves the files in its www folder, so move your files into www before you build or deploy. Files at the root of the project are not uploaded.

To run the command from a script, pass --name, --preset, and --auto. The command then asks no question.

Examples

Each example shows the command and the output it prints.

This command links a static HTML site named my-site and asks no question:

azion link --name my-site --preset html --auto

The command writes the project files and reminds you to build the project:

Text
01Project successfully configured
02Sucessfully written to your .gitignore file
03Successfully created GitHub Actions workflow file at .github/workflows/azion-deploy.yml
04…
05Please, remember to run azion build --preset [preset-name], in order to generate the necessary configuration files

The command adds .edge/, .vulcan, and .open-next to .gitignore, writes azion.config.cjs, and writes azion/azion.json with no resource IDs:

JSON
01{
02 "name": "my-site",
03 "bucket": "",
04 "preset": "html",
05 "env": "production",
06 "prefix": "",
07 "rotate-prefix": true,
08 "function": [],
09 "application": {
10 "id": 0,
11 "name": "__DEFAULT__"
12 },
13 "domain": {
14 "id": 0,
15 "name": "__DEFAULT__",
16 "domain_name": "",
17 "url": ""
18 },
19 "rt-purge": {
20 "purge_on_publish": true
21 },
22 "origin": null,
23 "rules-engine": {
24 "created": false,
25 "rules": null
26 },
27 "cache-settings": null,
28 "workloads": {
29 "id": 0,
30 "name": "",
31 "domains": null,
32 "url": "",
33 "deployment_id": null
34 },
35 "connectors": null
36}

The workflow in .github/workflows/azion-deploy.yml runs azion build and azion deploy --local when you start it by hand in GitHub. It reads a personal token from the AZION_PERSONAL_TOKEN secret of the repository.

This command links the same kind of site and asks a question at each step:

azion link --name my-site

The command asks you to confirm the folder, then opens the preset picker. This example answers yes to .gitignore, no to the workflow, yes to the build, and no to the dependencies, the local development server, and the deploy:

Text
01🤔 Do you want to link <project-dir> to Azion? (y/N) y
02
03Getting presets available (Some dependencies may need to be installed)
04…
05? Choose a preset: html
06Project successfully configured
07🤔 Azion CLI creates some files during the build process for internal use. Would you like to add these to your .gitignore file? (Y/n) Y
08Sucessfully written to your .gitignore file
09🤔 Would you like to add a GitHub Actions workflow for automated deployment? (Y/n) n
10…
11🤔 Do you allow Azion to build your project in order to generate configuration files? (Y/n) Y
12🤔 Do you want to install project dependencies? This may be required to start local development server (Y/n) n
13
14
15Building your Application. This process may take a few minutes
16Running build step command:
17
18$ npx --yes @aziontech/bundler@1.1.4 build --preset html
19…
20[Azion] [Build] › ℹ info Using preset: html
21[Azion] [Pre-Build] › ℹ info Starting pre-build...
22[Azion] [Pre-Build] › ℹ info Pre-build completed successfully
23[Azion] [Build] › ℹ info Using built-in handler from "html" preset.
24[Azion] [Build] › ℹ info Starting build...
25[Azion] [Build] › ✔ success Build completed successfully
26[Azion] [Post-Build] › ℹ info Starting post-build...
27[Azion] [Post-Build] › ✔ success Post-build completed successfully
28[Azion] [Storage] › ℹ info Using provided prefix for storage '$BUCKET_NAME': $BUCKET_PREFIX
29[Azion] [IaC] › ✔ success Manifest generated successfully at <project-dir>/.edge/manifest.json
30Your Application was built successfully
31🤔 Do you want to start a local development server? (y/N) n
32If you want to start a local development server later, run 'azion dev'
33🤔 Do you want to deploy your project? (y/N) n
34If you want to deploy your application later, run 'azion deploy'
35Your application my-site was linked successfully

Without --name, the command asks for the name after the folder question and suggests a random one:

? (Hit enter to accept the suggested name in parenthesis) Your application's name: (affectionate-rainbow)
Azion CLI init

The command that creates a project from a template instead of linking an existing folder.

Azion CLI dev

How to run the linked project on your machine before you deploy it.

Azion CLI deploy

The command that creates the resources the azion folder points to and deploys the project.

Azion CLI unlink

The command that removes the azion folder of the project and can also delete its remote resources.