Reading the repo
Opening the box…
Reading the repo
Opening the box…
How to install on Windows
Desktop app that records your on-screen work session and uses the GitHub Copilot SDK to reconstruct it as an intent + ordered steps, then builds a reusable Skill or Automation for Microsoft Autopilots like Scout, Microsoft Copilot Cowork, or Copilot Studio.
Saved setup from 2 h ago
Will it work on Windows?
The maintainers included install.ps1. Run it from the cloned folder after reading it.
powershell -ExecutionPolicy Bypass -File .\install.ps1
Also: install.sh
INSTALL.md[!TIP] Just want to install and use the app? Go to the latest release. Scroll to Commit-pinned installation and copy the complete command for your operating system. Paste it into PowerShell on Windows or Terminal on macOS or Ubuntu, then press Enter. No changes to the command are needed. See the step-by-step guide for more help.
This page is the advanced installation reference, including script inspection, configuration, and manual developer setup. The commands below are templates, not ready-to-run release commands.
Skill Recorder can run directly from an exact source revision on Windows, macOS, or Ubuntu. These methods do not download a prebuilt Skill Recorder application. Node.js, Electron, native dependencies, and the GitHub Copilot CLI are obtained from canonical upstreams or compatible configured registries and assembled locally.
The generated build is for local execution only. Do not redistribute the build,
node_modules, or downloaded runtimes. Release binaries must use the
repository's npm run dist* commands and include the complete generated
compliance bundle.
Replace <40-character-release-commit> with the full 40-character commit SHA
published for the release. Do not run a command with that placeholder still in it:
it is not a real version and the download will fail. For a command with the correct
value already filled in, use the
latest release.
$commit="<40-character-release-commit>"; $env:SKILL_RECORDER_COMMIT=$commit; irm "https://raw.githubusercontent.com/microsoft/skill-recorder/$commit/install.ps1" | iex
commit="<40-character-release-commit>"; curl -fsSL "https://raw.githubusercontent.com/microsoft/skill-recorder/$commit/install.sh" | SKILL_RECORDER_COMMIT="$commit" bash
To launch in the background and retain rolling logs on macOS or Ubuntu:
commit="<40-character-release-commit>"; curl -fsSL "https://raw.githubusercontent.com/microsoft/skill-recorder/$commit/install.sh" | SKILL_RECORDER_COMMIT="$commit" SKILL_RECORDER_DETACHED=1 bash
The commit appears twice deliberately: it pins both the script being executed
and the source that the script builds. Never replace it with master, main, a
branch name, or an unverified tag.
The source installers:
install.sh accepts macOS and Ubuntu only.nodejs.org and verify
its archive against Node.js's SHASUMS256.txt. Windows additionally verifies
the OpenJS Foundation Authenticode signature.npm ci through
the user's configured registry or compatible mirror, install Electron from its
official release endpoint, and confirm Electron's official checksum manifest
matches the reviewed compliance policy.npm run compliance:licenses and fail if any installed platform package
lacks reviewed legal material.Skill Recorder (Source) app in ~/Applications (reachable from Spotlight,
Launchpad, and the Dock) on macOS; and a launcher plus desktop entry on Ubuntu.On Windows, installation does not launch the app, even on a first install.
The terminal shows an @-bordered completion notice: finish recording, choose
Quit in all running copies, wait for them to close, then open Skill Recorder
(Source) using the shortcut. If neither shortcut could be created, the notice
provides a manual launch command instead. macOS and Ubuntu retain automatic
launch unless disabled with SKILL_RECORDER_NO_LAUNCH=1.
No administrator access, global Node.js installation, or global Copilot CLI installation is required. AI features require network access and either GitHub Copilot authentication/entitlement or a supported model provider's API key. Choose between them at the first AI action; recording needs neither. See Bring your own model for endpoint/model requirements and secure-key storage on Windows, macOS, and Ubuntu. If a secure OS store is unavailable, the key form explains the automatic memory-only fallback; this does not block BYOM. Ubuntu needs an unlocked supported desktop keyring to remember keys between launches.
Piping a downloaded script directly to a shell gives you no opportunity to inspect it first and may be disabled by enterprise policy. The inspect-first procedures below are preferred.
Source installation is not a security-policy bypass. Gatekeeper, Smart App Control, application-control policy, or endpoint protection may still block downloaded or locally assembled components.
Compare the displayed script SHA-256 with the value published in the corresponding GitHub Release before executing it.
$commit = "<40-character-release-commit>"
$script = Join-Path $env:TEMP "skill-recorder-install-$commit.ps1"
Invoke-WebRequest "https://raw.githubusercontent.com/microsoft/skill-recorder/$commit/install.ps1" -OutFile $script -UseBasicParsing
Get-FileHash $script -Algorithm SHA256
Get-Content $script
$env:SKILL_RECORDER_COMMIT = $commit
& $script
commit="<40-character-release-commit>"
script="$(mktemp -t skill-recorder-install.XXXXXX)"
curl -fsSL "https://raw.githubusercontent.com/microsoft/skill-recorder/$commit/install.sh" -o "$script"
shasum -a 256 "$script"
cat "$script"
SKILL_RECORDER_COMMIT="$commit" bash "$script"
rm -f "$script"
commit="<40-character-release-commit>"
script="$(mktemp --suffix=.sh)"
curl -fsSL "https://raw.githubusercontent.com/microsoft/skill-recorder/$commit/install.sh" -o "$script"
sha256sum "$script"
cat "$script"
SKILL_RECORDER_COMMIT="$commit" bash "$script"
rm -f "$script"
| Variable | Platforms | Meaning |
| --- | --- | --- |
| SKILL_RECORDER_COMMIT | all | Required full 40-character source commit |
| SKILL_RECORDER_INSTALL_ROOT | all | Override the per-user source/runtime directory |
| SKILL_RECORDER_NO_LAUNCH=1 | macOS, Ubuntu | Install and validate without launching; Windows never auto-launches |
| SKILL_RECORDER_NO_DESKTOP_SHORTCUT=1 | Windows | Create only the Start Menu shortcut |
| SKILL_RECORDER_DETACHED=1 | macOS, Ubuntu | Launch in the background with file logging |
| SKILL_RECORDER_LOG_KEEP | macOS, Ubuntu | Number of detached launch logs to retain; default 5 |
Default installation roots:
%LOCALAPPDATA%\SkillRecorder~/Library/Application Support/SkillRecorder${XDG_DATA_HOME:-~/.local/share}/SkillRecorderEvery revision is installed under versions/<commit>. The current launcher is
updated only after the selected revision passes dependency, license, integrity,
and build checks.
Running the Windows command again with the same commit does not download or
rebuild anything. The installer verifies the existing versions/<commit>
installation, refreshes the Start Menu and desktop shortcuts, and prints the
manual launch instructions without starting the app.
If an earlier attempt failed part-way, the portable Node.js archive and the
source archive it had already fetched are kept in <install root>\cache and
reused on the next attempt. Cached files are re-verified by SHA-256 before use —
the Node.js archive against the checksums published by nodejs.org on every run —
and are deleted once the revision is installed. Deleting the cache directory is
always safe.
After a successful install you can reopen Skill Recorder without re-running the installer:
~/Applications, searchable from
Spotlight and Launchpad and pinnable to the Dock.Each entry runs the current launcher, so it always starts the most recently installed revision when no copy is already running. New revisions share a single-instance lock: another launch reveals the existing recorder or recording controls without starting or stopping a recording. If a different revision is already running, quit it before launching the newly installed one.
Legacy revisions without that lock can still run alongside a newer revision. The Windows completion notice is a manual handover instruction, not automatic detection or shutdown of those older copies.
[!IMPORTANT] This section is for developers who want to work on the code. It is not required to install or use Skill Recorder. Use the ready-to-run command on the release page instead. If you continue below, replace
<40-character-release-commit>with the release's actual full commit SHA before running any commands. Pasting the placeholder literally causes a 404 Not Found error and the remaining steps cannot work.
Install Node.js 24.19 or newer within the Node.js 24 release line from its official publisher. This supplies npm 11.17 or newer, which is required to enforce the reviewed dependency lifecycle-script policy. Download the exact commit archive rather than repository history.
$commit = "<40-character-release-commit>"
$archive = Join-Path $env:TEMP "skill-recorder-$commit.zip"
$parent = Join-Path $PWD "skill-recorder-source"
Invoke-WebRequest "https://codeload.github.com/microsoft/skill-recorder/zip/$commit" -OutFile $archive -UseBasicParsing
Expand-Archive $archive $parent
Set-Location (Join-Path $parent "skill-recorder-$commit")
npm run check:lockfile
npm ci --ignore-scripts=false --dangerously-allow-all-scripts=false --strict-allow-scripts
npm run electron:install-reviewed
npm run compliance:licenses
npm run build
npm start
commit="<40-character-release-commit>"
archive="skill-recorder-$commit.tar.gz"
source_dir="skill-recorder-$commit"
curl -fsSL "https://codeload.github.com/microsoft/skill-recorder/tar.gz/$commit" -o "$archive"
mkdir "$source_dir"
tar -xzf "$archive" --strip-components=1 -C "$source_dir"
cd "$source_dir"
npm run check:lockfile
npm ci --ignore-scripts=false --dangerously-allow-all-scripts=false --strict-allow-scripts
npm run electron:install-reviewed
npm run compliance:licenses
npm run build
npm start
Install the basic archive/download tools if the machine does not already have them:
sudo apt-get update
sudo apt-get install --yes ca-certificates curl tar
Then use the same pinned source process:
commit="<40-character-release-commit>"
archive="skill-recorder-$commit.tar.gz"
source_dir="skill-recorder-$commit"
curl -fsSL "https://codeload.github.com/microsoft/skill-recorder/tar.gz/$commit" -o "$archive"
mkdir "$source_dir"
tar -xzf "$archive" --strip-components=1 -C "$source_dir"
cd "$source_dir"
npm run check:lockfile
npm ci --ignore-scripts=false --dangerously-allow-all-scripts=false --strict-allow-scripts
npm run electron:install-reviewed
npm run compliance:licenses
npm run build
npm start
For hot-reload development, run npm run dev after the validated install
sequence above and npm run compliance:licenses.
The lockfile pins the dependency graph with canonical registry.npmjs.org URLs
and integrity hashes. npm may map those URLs to a configured compatible
corporate registry. Use npm ci, not npm install, and do not regenerate the
lockfile during installation. Keep the entire checkout, .compliance, and
dependency legal files.
The installers run a portable Node.js runtime that is unpacked into the
installation root. Because Node.js's portable archives ship no builtin npmrc,
npm would resolve its global configuration inside that throwaway runtime
directory and ignore the registry configured for the machine. The installers
therefore locate the machine's real global npmrc and pass it to the portable npm
so that replace-registry-host maps the lockfile's canonical npmjs URLs onto the
configured mirror. Machines with no npm configuration are unaffected and continue
to use registry.npmjs.org.
On Windows, this discovery does not require Node.js or npm to be installed.
The installer preserves an explicit NPM_CONFIG_GLOBALCONFIG; otherwise it
checks the system npm's reported global configuration, an explicit
NPM_CONFIG_PREFIX (etc\npmrc beneath that prefix), or the standard locations:
%APPDATA%\npm\etc\npmrc, then nodejs\etc\npmrc beneath the native, current,
and x86 Program Files directories. This includes managed configuration placed
in those locations before npm is available on PATH. Existing user .npmrc
and npm environment settings retain npm's normal precedence. The installer
does not modify these files.
This reads locally available settings; it does not trigger an Intune/device-policy sync. On an unconfigured Windows machine, a public-registry network failure can trigger one Microsoft-specific recovery attempt if local device/account metadata provides a Microsoft Entra tenant hint. This is only a routing hint, not authorization. The installer announces the retry, applies the registry only to the retry process, and preserves lockfile integrity and script approvals. It never changes saved settings or weakens TLS verification. Explicit npm configuration, other organizations, and non-network failures do not trigger this fallback. If recovery is unavailable or fails, the installer stops with guidance for your organization's approved package-feed provisioning.
If npm is already on PATH, configure a mirror once with:
npm config set registry <url> --location=global
If npm is not installed globally, the Windows installer's dependency-error message includes a command using the exact path to its downloaded npm. That command sets the approved registry in your user configuration; substitute the URL supplied by your organization and follow its feed-authentication instructions.
The installers preserve existing npm configuration. The Windows recovery path above is limited to an otherwise unconfigured public-registry failure. The lockfile's integrity hashes are verified whichever registry serves the packages, so a mirror cannot substitute different content.
The source channels distribute this repository's MIT-licensed source. The user's package manager obtains Sharp/libvips, ONNX Runtime, Tesseract.js, the unmodified GitHub Copilot CLI, and other npm dependencies through its configured registry; the installer obtains the reviewed Electron runtime from GitHub. Canonical registry URLs and integrity hashes keep the lockfile portable across direct npmjs access and compatible corporate mirrors. The local build is not a redistributable application package.
Each platform's compliance check retains:
LICENSE and THIRD-PARTY-NOTICES.md;.compliance/licenses;.compliance;.compliance/tesseract-core;Anyone redistributing a generated application must instead use the supported
npm run dist* pipeline. It packages the exact notices, corresponding source,
patches, hashes, and relinking instructions required by the bundled libraries.
To update, rerun the source installer with the new release's full commit SHA. On Windows, the installer leaves running copies untouched and does not launch the new revision. Finish recording, choose Quit in every running copy, wait for shutdown to finish, then use the refreshed shortcut to open the installed revision. Do not rerun the installer just to reopen the app. Test the new revision before deleting an older revision.
Remove-Item "$([Environment]::GetFolderPath('Programs'))\Skill Recorder (Source).lnk" -Force
Remove-Item "$([Environment]::GetFolderPath('DesktopDirectory'))\Skill Recorder (Source).lnk" -Force
Remove-Item "$env:LOCALAPPDATA\SkillRecorder" -Recurse -Force
rm -rf "$HOME/Applications/Skill Recorder (Source).app"
rm -rf "$HOME/Library/Application Support/SkillRecorder"
data_home="${XDG_DATA_HOME:-$HOME/.local/share}"
rm -f "$data_home/applications/skill-recorder-source.desktop"
rm -rf "$data_home/SkillRecorder"
These commands leave recorded-session/application data outside the source installation root intact.
The complete repeatable process is documented in
RELEASING.md.
install.ps1 and install.sh.npm run dist* and publish the complete,
version-matched compliance materials.Then run powershell -ExecutionPolicy Bypass -File .\setup.ps1. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: winget install Git.Git
git clone https://github.com/microsoft/skill-recorder.git cd skill-recorder
Node.js >=24.19.0 <25
winget install CoreyButler.NVMforWindows nvm install lts nvm use lts
npm ci
npm run dev
npm test
Skill Recorder is published as a source release: one command downloads a pinned Node.js runtime, builds the exact release commit on your machine, and adds a Skill Recorder (Source) app you can relaunch anytime. Nothing is installed globally. You'll need either a GitHub account with Copilot access, or a supported model provider's API key; the Copilot CLI ships with the app and powers both options.
macOS is the primary target. Windows 11 (x64 and ARM64) is supported too (see
WINDOWS-VALIDATION.md).
Open the latest release and follow these steps:
[!IMPORTANT] Copy the command from the release page, not a template from the technical docs. The release command already contains the correct version identifier; there is nothing to replace. Do not paste commands containing
<40-character-release-commit>literally. You do not need Git, a separate Node.js installation, or the Manual developer setup instructions. The Source code (zip) and Source code (tar.gz) links under Assets are not app installers.
To review the script before running it, follow the release page's inspect-first instructions instead. Installation remains subject to your organization's policies.
Open it again later: use Skill Recorder (Source) on your Windows desktop or
Start Menu; on macOS, find it in ~/Applications, Spotlight, or Launchpad; on
Ubuntu, use the matching application entry. You do not need to reinstall each time.
Launching again reveals the existing recorder or recording controls instead of
starting another copy. Older revisions without this protection must be quit
manually before opening an updated revision.
Advanced options, including running in the background on macOS or Ubuntu, are in
INSTALL.md.
On Windows, a local Microsoft Entra tenant hint can offer a choice between
Microsoft Enterprise SSO and a Personal GitHub account. This is only a
routing hint, not proof of employment. Microsoft sign-in has two separate steps:
finish SSO in the browser, then authorize the GitHub Copilot app. When SSO lands on
github.com/enterprises/microsoft, close that tab, return to Skill Recorder, and
choose Authorize Copilot. SSO alone does not authorize the app. Use the same
browser profile and Microsoft-linked GitHub account for both steps.
Without a hint, and on macOS/Linux,
sign-in goes directly to the standard GitHub flow. No work-email prompt is required.
The authorization step opens the default browser using the CLI's web OAuth flow, not a device code. Keeping the same browser profile lets GitHub reuse the session from SSO, so you can approve the GitHub Copilot app without entering a code. If GitHub asks you to sign in again, check that you are using the same browser profile. After authorization, close that tab and return to Skill Recorder; the app verifies access before continuing.
Skill Recorder pins Copilot CLI 1.0.78, which supports web OAuth without a terminal,
and runs --no-auto-update login --web-flow so sig
…
No reports for Windows yet.
GitManual AI Agent reads the 6 key files and writes a step-by-step guide for Windows. Once written, it's saved for everyone.