This page documents how to update Agent OS including:
- Upgrading your base installation to the newest version of Agent OS
- Pushing updates to your project repositories
Note: If you're upgrading from Agent OS 1.x to 2.x, see the Version 2 Migration Guide.
For notes on the latest version of Agent OS, see the changelog.
Updating your base installation
Your base installation in ~/agent-os
is the source where your project installations will be compiled from. Update your base installation so that you have the latest version of Agent OS available on your system.
Note: Updating your base installation will not automatically update your project installations. You will need to update your project installations separately by following these instructions below.
Running the base installation update
curl -sSL "https://raw.githubusercontent.com/buildermethods/agent-os/main/scripts/base-install.sh" | bash
For safety: The script will detect your current version, show you the newest version, ask for confirmation, back up your existing installation to ~/agent-os.backup
, then apply the update to ~/agent-os
.
What gets updated
- Updated: Core scripts, default profile, workflows, and agents
- Preserved: Custom profiles you've created (anything other than 'default')
- Overwritten: The 'default' profile (if you confirm when prompted)
Important: If you've customized your default profile's standards, back them up before updating, or you can use the backup that will be automatically created at ~/agent-os.backup
during the udpate. You'll need to re-merge your 'default' profile's customizations after the update.
Updating your project installations
After you've updated your base installation, or after you've made changes to your base installation, if you want to push those updates to individual project installations, you'll need to run a project update. Project updates re-compile Agent OS from your base installation into your project installation.
Running a project update
Navigate to the root of your project directory:
cd /path/to/your/project
You can use either the explicit project update script:
~/agent-os/scripts/project-update.sh
Or re-run the installation script. If it detects that your project already has an Agent OS installation, it will update it.
~/agent-os/scripts/project-install.sh
The update process will detect your current configuration, compare it with the incoming configuration, show you differences, let you choose which version to keep, then apply the update.
Notes:
- The script with no flags applied will not overwrite any files in your project installation. It would only add new files that don't already exist. Most of the time, you will want to update existing files, so to do that, you can use any combination of flags listed below under Update options.
- If you've made customizations to your project's standards that don't yet exist in the profile that you're updating from, you'll need to re-merge those after the update.
- Updating your project will never overwrite or delete:
agent-os/product
(your product roadmap, mission, and tech stack)agent-os/specs
(your feature specs and implementations)
Update options
Append any combination of the following flags to the project update script to control what gets updated:
Flag
--overwrite-standards
Description
Flag
--overwrite-workflows
Description
Flag
--overwrite-commands
Description
Flag
--overwrite-agents
Description
Flag
--overwrite-all
Description
Flag
--dry-run
Description
Common update scenarios
curl -sSL "https://raw.githubusercontent.com/buildermethods/agent-os/main/scripts/base-install.sh" | bash
cd /path/to/your/project
~/agent-os/scripts/project-update.sh
~/agent-os/scripts/project-update.sh --overwrite-standards
Caution: Back up any project-specific customizations first.
~/agent-os/scripts/project-update.sh --overwrite-agents
This will effectively be a fresh re-installation of Agent OS into your project using the new profile.
~/agent-os/scripts/project-install.sh --profile your-new-profile
This will effectively be a fresh re-installation of Agent OS into your project using the new mode(s).
Add both modes (multi-agent and single-agent):
~/agent-os/scripts/project-install.sh --multi-agent-mode true --single-agent-mode true
Single-agent only:
~/agent-os/scripts/project-install.sh --single-agent-mode true --multi-agent-mode false
Multi-agent only:
~/agent-os/scripts/project-install.sh --multi-agent-mode true --single-agent-mode false
If you want to look "under the hood" in your base installation to see where how your standards files will be injected into agent instructions and workflows, you can use the following command to search your installation for the string, {{standards
.
grep -r "{{standards" ~/agent-os/
You may want to focus this search on a particular profile in your base installation.
grep -r "{{standards" ~/agent-os/profiles/default/
grep -r "{{standards" ~/agent-os/profiles/your-profile/