Index of every page on this site: llms.txt
All skills
encoredev avatar

/install

@e86a3ab official
by Encoreencoredev/skills30 stars
6
Run it yourself

Install the Encore CLI, check whether it's installed, put it on the PATH, update it, and check what local development needs (Docker, plus Node.js for Encore.ts). The same steps work for Encore.ts and Encore.go.

  • 1 file
  • 3.5 KB
  • Updated 4 weeks ago
  • GitHub
Use this Skill: https://skilld.dev/gh/encoredev/skills/install

Nothing lands on disk. Nothing to clean up.

Fork this Skill

Edit a local copy. It keeps the author and licence.

SKILL.md

≈55 tokens for metadata: the name and description. ≈682 when used: this file.

Description uses 9.8% of example budget

Before choosing a Skill, your Agent reads its name and description. All available Skills share that space.

  • A shorter description leaves more room for other Skills. This entry exceeds our 1% size suggestion.

In our Claude Code example, all Skill names and descriptions share 8,000 characters. This Skill uses ≈785 characters, or 9.8%.

The 1% threshold is a size suggestion. Longer descriptions can still fit.

Your model, settings, and other Skills decide how much text your Agent can read.

Example settings and source

The example uses a 200k-token context and default Claude Code settings. The count includes the name, description, separators, and when_to_use when present. Codex also counts local file paths.

Skit's source and limits: Codex 0.160.1, Claude Code 2.1.292.

Installing the Encore CLI

Instructions

Do the steps in order.

1. Check whether it's installed

encore version
  • Prints encore version v...: installed. Go to step 4.
  • Command not found: run ~/.encore/bin/encore version. If that prints a version, Encore is installed but not on the PATH: go to step 3. Otherwise go to step 2.

2. Install

Ask the user first, unless they asked you to install Encore. Run the command for the OS. None of them prompt for input.

# macOS
brew install encoredev/tap/encore

# Linux, WSL, or macOS without Homebrew
curl -L https://encore.dev/install.sh | bash

# Windows (PowerShell)
iwr https://encore.dev/install.ps1 | iex

Run encore version again. If it's still not found, go to step 3. On Windows, open a new shell instead: the installer adds %USERPROFILE%\.encore\bin to the PATH, but shells that were already open don't see it.

3. Put it on the PATH

install.sh installs to ~/.encore/bin and doesn't edit shell profiles. Add it to the PATH:

export ENCORE_INSTALL="$HOME/.encore"
export PATH="$ENCORE_INSTALL/bin:$PATH"

Agent shells often drop environment variables between commands. Prefix each encore command with these exports, or call ~/.encore/bin/encore by its full path. To make it permanent, ask the user, then add the two lines to their shell profile (~/.zshrc for zsh, ~/.bashrc for bash).

4. Check what the app needs

Tool Needed for Check If it fails
Docker Apps with SQL databases (encore run, encore test) docker info Not installed: ask the user to install Docker. Not running: start it (macOS: open -a Docker) and wait until docker info succeeds
Node.js and npm Encore.ts apps node --version Ask the user to install Node.js
git Creating apps and deploying git --version Ask the user to install git

Encore.go needs no separate Go install: the CLI includes the Go toolchain it builds with. Other local infrastructure (Pub/Sub, caches, buckets, cron) runs without Docker.

Updating

encore version update

This uses Homebrew if Encore was installed with it, and the install script otherwise. Then update the app's encore.dev package to match: npm install encore.dev@latest (Encore.ts) or go get encore.dev@latest (Encore.go).

Guidelines

  • When encore isn't found right after installing, fix the PATH (step 3). Don't install again.
  • Ask before installing software or editing shell profiles, unless the user asked you to.
  • Next: log in (encore-login), create an app (encore-create-app), and run it (encore-run).
  • Docs: https://encore.dev/docs/quick-start

Source: SKILL.md on GitHub

skilld matched fixed text patterns in SKILL.md and file names. Patterns miss obfuscated code.

skilld run checks every file with the same patterns. It asks for approval before it loads a Skill with a behavior marked Needs approval.

No third-party reports yet.

Signed by skilld at e86a3ab. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 4 weeks ago.

Activeupdated 4 weeks ago
Other metadata
when_to_use
The `encore` command isn't installed or isn't found, the user wants to install, set up, update, or upgrade the Encore CLI, or a task needs the CLI before any other Encore step (creating, running, testing, or deploying an app). Also use when `encore run` or `encore test` fails because Docker isn't installed or isn't running. Trigger phrases: "install Encore", "set up Encore", "encore: command not found", "brew install encoredev/tap/encore", "install.sh", "update Encore", "upgrade the Encore CLI", "encore version update", "docker daemon is not running".

README badge

README badge for encoredev/skills/install