Skip to content

README.md

Latest commit

 

History

History
67 lines (48 loc) · 1.61 KB

README.md

File metadata and controls

67 lines (48 loc) · 1.61 KB

Note

This tool is only used for managing Deno Deploy Classic organizations and their projects. New Deno Deploy organizations use the deno deploy command built into the Deno Runtime. Learn more about the new deno deploy command in the reference docs

deployctl

deployctl is the command line tool for Deno Deploy. This repository also contains the denoland/deployctl GitHub Action.

Prerequisite

You need to have Deno 1.46.0+ installed (latest version is recommended; just run deno upgrade)

Install

deno install -gArf jsr:@deno/deployctl

Usage

The easiest way to get started with deployctl is to deploy one of the examples in the examples directory:

cd examples/hello-world
deployctl deploy

Visit the deployctl docs and check out the help output to learn all you can do with deployctl:

deployctl -h

Action Example

name: Deploy

on: push

jobs:
  deploy:
    runs-on: ubuntu-latest

    permissions:
      id-token: write # This is required to allow the GitHub Action to authenticate with Deno Deploy.
      contents: read

    steps:
      - name: Clone repository
        uses: actions/checkout@v4

      - name: Deploy to Deno Deploy
        uses: denoland/deployctl@v1
        with:
          project: my-project # the name of the project on Deno Deploy
          entrypoint: main.ts # the entrypoint to deploy

To learn more about the action, checkout action readme.