@architect/architect

Build ultra scalable database backed web apps on AWS serverless infrastructure with full local, offline workflows, and more. Full documentation found at: https://arc.codes

Requirements

• Platforms: Linux, macOS, Windows
• Architect runtime: Node.js 14+
• Function runtimes & package managers:
  • Node.js (optional): supported versions
    • npm (optional): 6+
    • yarn (optional): 1+
  • Python (optional): supported versions
    • pip3 (optional)
  • Ruby (optional): supported versions
    • bundle (optional)
• Additional function runtimes:
  • Java, .NET, Golang, Lambda runtime layers (optional): supported versions

Installation

Make sure you have at least Node.js version 14 installed.

Open your terminal to install arc:

npm i @architect/architect --save-dev

Check the version:

npx arc version

Protip: run arc with no arguments to get help

Work locally

Create a new app:

mkdir testapp
cd testapp
npx arc init

Kick up the local dev server:

npx arc sandbox

Cmd / Ctrl + c exits the sandbox

Deploy to AWS

Deploy the staging stack:

npx arc deploy

Protip: create additional staging stacks with --name

Ship to a production stack:

npx arc deploy --production

Add Architect syntax to your text editor

– VS Code

– Sublime Text

– Vim

Learn more

Head to https://arc.codes to learn more!

Founding team

Amber Costley, Angelina Fabbro, Brian LeRoux, Jen Fong-Adwent, Kristofer Joseph, Kris Borchers, Ryan Block, Spencer Kelley

Special thanks

Pinyao Guo for the Architect GitHub name

Changelog

[11.2.1] 2025-04-03

Added

• Passing the -h or --help flag to individual arc commands now prints the command's help text; an alias for arc help <command>

Changed

• Updated help text for all arc commands.