setup

Automate aweek project initialization with filesystem layout and heartbeat scheduling.

11|1|Updated Apr 20, 2026
One-click install
npx skills add https://github.com/runbear-io/aweek --skill setup-runbear-io
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: setup
Source: https://github.com/runbear-io/aweek/tree/main/skills/setup
Command: npx skills add https://github.com/runbear-io/aweek --skill setup-runbear-io

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Bootstrap an aweek project and set up the filesystem layout and optional heartbeat scheduling so teams can automate repeated work.

Core Features & Use Cases

  • Create the required project layout (.aweek/agents) and data directory
  • Install the heartbeat scheduler (launchd on macOS or cron on Linux) when confirmed
  • Safe, idempotent onboarding with non-destructive defaults

Quick Start

Run /aweek:setup to bootstrap a new project and optionally install the 10-minute heartbeat.

Frequently Asked Questions about setup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I bootstrap an aweek project and set up its filesystem layout?

To bootstrap an aweek project, run the setup command which creates the required project directory layout, including the .aweek/agents folder and data directory, ensuring safe and idempotent onboarding.

How do I configure a heartbeat scheduler on macOS and Linux for automated work?

You can configure a heartbeat scheduler during project setup by opting into the heartbeat installation, which automatically configures launchd on macOS or cron on Linux to run the 10-minute heartbeat.

Does the aweek project setup work on both macOS and Linux?

Yes, the aweek project setup works across macOS and Linux, coordinating the filesystem layout and installing the appropriate scheduler, either launchd or cron, based on the detected operating system.

Can I reinitialize an existing aweek project without losing data?

Yes, you can reinitialize an existing aweek project safely because the setup enforces an idempotent init flow with non-destructive defaults, applying safety checks and destructive operation policies to prevent data loss.

How do I customize the project directory and data directory when initializing an aweek project?

You can customize the project directory and data directory during initialization by configuring the runInit flow options, allowing you to specify the exact paths for your projectDir and dataDir.

What are the limitations or safety considerations when installing a heartbeat scheduler?

The main safety consideration when installing a heartbeat scheduler is that the setup enforces non-destructive defaults and requires confirmation before installing cron or launchd, preventing unintended destructive operations.