Skip to content

Skatterbrainz/psWarpTerminal

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

44 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

psWarpTerminal

PowerShell wrapper for the Warp Terminal (warp-terminal or Oz) CLI

  • Updated: June 7, 2026

PowerShell Platform Platform Platform License

Idiomatic PowerShell functions that wrap the warp-terminal or oz CLI, giving you structured objects, pipeline support, and tab-completion instead of raw text output.

🎯 Overview

This module exposes 40 public functions covering the current oz CLI surface. Every function returns parsed PSCustomObject output (via --output-format json under the hood), so results plug directly into Format-Table, Where-Object, Export-Csv, and the rest of the PowerShell ecosystem.

Important Note

Both warp-terminal and oz CLI are still being developed, so features may not always be aligned with the Warp GUI. I will try to keep this module updated as often as features change, but feel free to submit PR's for anything you feel would enhance or repair this module. Thank you!

✨ Features

  • πŸ€– Agent Operations - Launch local or cloud agents, list available agents and profiles, with automatic conversation continuation
  • πŸ“‹ Run Management - List and inspect ambient agent task runs
  • 🧠 Reusable Agent Management - Create, update, inspect, list, and delete reusable agents
  • πŸ“¦ Artifact Management - Fetch metadata for and download files produced by cloud agent runs
  • 🌐 Environment Management - Create, update, delete, and inspect cloud environments and base images
  • πŸ” Secret Management - Create, update, delete, and list secrets in Warp's secure storage
  • πŸ”‘ API Key Management - Create, list, and expire Oz API keys
  • ⏰ Schedule Management - Create, update, pause, resume, and delete scheduled (cron) agents
  • πŸ”Œ Integrations - List, create, and update integrations (Linear, Slack) with full parameter support
  • βš™οΈ Settings - Read and parse the local Warp settings.toml into a PowerShell object
  • 🧩 Utility - List models/MCP, inspect skills, identify current user, manage authentication, and issue federated identity tokens

Requirements

  • PowerShell 7.0 or higher (tested with 7.5 and 7.6)
  • warp-terminal CLI installed and in your PATH
  • A Warp account (authenticate via Connect-Warp)

Installation

From PowerShell Gallery

Install-PsResource psWarpTerminal

From GitHub

  1. Clone the repository

    git clone https://github.com/ds0934/psWarpTerminal.git
    cd psWarpTerminal
  2. Import the module

    Import-Module ./psWarpTerminal.psd1

Usage

Import the module and explore available cmdlets:

# Import the module
Import-Module psWarpTerminal

# Get all available cmdlets
Get-Command -Module psWarpTerminal

# Authenticate
Connect-Warp

# Launch a cloud agent
Invoke-WarpAgent -Cloud -Prompt "Build a REST API" -Environment "my-env-id" -Open

# List recent runs
Get-WarpRun -Limit 5

# Inspect a specific run
Get-WarpRun -TaskId "abc123"

# List environments, pipe to delete
Get-WarpEnvironment | Where-Object name -eq "old-env" | Remove-WarpEnvironment

# Create a scheduled agent
New-WarpSchedule -Name "daily-review" -Cron "0 9 * * *" -Prompt "Review open PRs" -Environment "my-env-id"

# Schedule a skill instead of a prompt
New-WarpSchedule -Name "nightly-deps" -Cron "0 2 * * *" -Skill "myorg/infra:dep-update"

# Pause / resume a schedule
Suspend-WarpSchedule -Id "sched-id"
Resume-WarpSchedule -Id "sched-id"

# Read local Warp settings
(Get-WarpSettings).appearance.themes.theme

πŸ”„ Conversation Continuation

Invoke-WarpAgent automatically tracks conversation context across calls. After the first invocation, follow-on prompts continue the same conversation without needing to pass a conversation ID manually.

# Start a new agent conversation
Invoke-WarpAgent -Prompt "Build a REST API"

# Follow-on prompt automatically continues the same conversation
Invoke-WarpAgent -Prompt "Now add unit tests"

# Inspect the stored context
Get-WarpAgentContext

# Start fresh by clearing the context
Clear-WarpAgentContext
Invoke-WarpAgent -Prompt "Something completely different"

Use -Verbose to see when auto-continuation is applied. You can always override by passing -Conversation explicitly.

πŸ“– Function Reference

Refer to the docs folder for current function references. Complete list of exported cmdlets (including conversation context helpers):

Agent

Function Description
Invoke-WarpAgent Run an agent locally (default) or in the cloud (-Cloud). Auto-continues conversations. Supports snapshot control
Get-WarpAgent List reusable agents or get one by -Id
Get-WarpSkill List available skills, optionally filtered by -Repo
New-WarpAgent Create a reusable agent
Set-WarpAgent Update a reusable agent's metadata, skills, secrets, model, or default environment
Remove-WarpAgent Delete a reusable agent (supports -WhatIf)
Get-WarpAgentProfile List agent profiles
Get-WarpAgentContext Inspect the stored conversation context from the last agent run
Clear-WarpAgentContext Reset the conversation context to start a fresh session

Runs

Function Description
Get-WarpRun List runs or get a specific run by -TaskId

Artifact

Function Description
Get-WarpArtifact Get metadata for an artifact by -Uid
Save-WarpArtifact Download an artifact file to disk (supports -WhatIf)

Environment

Function Description
Get-WarpEnvironment List environments or get one by -Id
New-WarpEnvironment Create a cloud environment
Set-WarpEnvironment Update an environment's name, image, repos, setup commands, etc.
Remove-WarpEnvironment Delete an environment (supports -WhatIf)
Get-WarpEnvironmentImage List available base images

Secret

Function Description
Get-WarpSecret List secrets
New-WarpSecret Create a secret
Set-WarpSecret Update a secret
Remove-WarpSecret Delete a secret (supports -WhatIf)

Schedule

Function Description
New-WarpSchedule Create a scheduled agent with -Prompt, -Skill, or both
Get-WarpSchedule List schedules or get one by -Id
Set-WarpSchedule Update a schedule's name, cron, prompt, skill, environment, MCP servers, etc.
Remove-WarpSchedule Delete a schedule (supports -WhatIf)
Suspend-WarpSchedule Pause a scheduled agent
Resume-WarpSchedule Unpause a scheduled agent

Integration

Function Description
Get-WarpIntegration List integrations
New-WarpIntegration Create an integration for a provider (linear, slack) with environment, MCP, and prompt support
Set-WarpIntegration Update an integration's prompt, environment, MCP servers, model, or worker host

Settings

Function Description
Get-WarpSettings Read and parse the local settings.toml into a PSCustomObject. Auto-detects path on Linux, macOS, and Windows

Authentication & Utility

Function Description
Connect-Warp Log in to Warp
Disconnect-Warp Log out (supports -WhatIf)
Get-WarpApiKey List active API keys
New-WarpApiKey Create an API key
Remove-WarpApiKey Expire an API key immediately (supports -WhatIf)
Get-WarpWhoAmI Print information about the logged-in user
Get-WarpModel List available models
Get-WarpMcp List MCP servers
Get-WarpFederatedToken Issue a federated identity token for a run

Contributing

Contributions are welcome! Feel free to:

  • Report bugs
  • Suggest new features or cmdlets
  • Improve documentation
  • Submit pull requests

Please open an issue or submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Version History

Version history has moved to ChangeLog.md.

About

PowerShell wrapper for the Warp Terminal (Oz) CLI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors