Skip to content

Workspace management package for `workspaces` folder shared between different packages.

License

Notifications You must be signed in to change notification settings

ppak10/workspace-agent

Repository files navigation

claude-code gemini-cli codex pytest codecov

workspace-agent

Workspace management package for workspaces folder shared between different packages.

Logo

Getting Started

Installation

uv add workspace-agent 

Usage

Command Line Interface (CLI)

  1. Create Workspace (along with folders and subfolders)
> workspace create test-workspace

# Expected Output
✅ Workspace created at: /Users/ppak/GitHub/workspace-agent/workspaces/test-workspace

> workspace create test-workspace test-folder

# Expected Output
✅ Workspace folder created at: /Users/ppak/GitHub/workspace-agent/workspaces/test-workspace/test-folder

> workspace create test-workspace test-folder test-subfolder

# Expected Output
✅ Workspace folder created at: /Users/ppak/GitHub/workspace-agent/workspaces/test-workspace/test-folder/test-subfolder
  1. Read Workspace
> workspace read test-workspace

# Expected Output
Workspace(
    name='test-workspace',
    path=PosixPath('/Users/ppak/GitHub/workspace-agent/workspaces/test-workspace'),
    folders={
        'test-folder': WorkspaceFolder(
            name='test-folder',
            path=PosixPath('/Users/ppak/GitHub/workspace-agent/workspaces/test-workspace/test-folder'),
            folders={'test-subfolder': WorkspaceFolder(name='test-subfolder', path=PosixPath('/Users/ppak/GitHub/workspace-agent/workspaces/test-workspace/test-folder/test-subfolder'), folders={}, files=[])},
            files=[]
        )
    },
    version='0.0.2',
    workspaces_path=PosixPath('/Users/ppak/GitHub/workspace-agent/workspaces'),
    config_file='workspace.json'
)

> workspace read test-workspace test-folder

# Expected Output
WorkspaceFolder(
    name='test-folder',
    path=PosixPath('/Users/ppak/GitHub/workspace-agent/workspaces/test-workspace/test-folder'),
    folders={'test-subfolder': WorkspaceFolder(name='test-subfolder', path=PosixPath('/Users/ppak/GitHub/workspace-agent/workspaces/test-workspace/test-folder/test-subfolder'), folders={}, files=[])},
    files=[]
)

> workspace read test-workspace test-folder test-subfolder

# Expected Output
WorkspaceFolder(name='test-subfolder', path=PosixPath('/Users/ppak/GitHub/workspace-agent/workspaces/test-workspace/test-folder/test-subfolder'), folders={}, files=[])

Model Context Protocol (MCP)

  1. Install MCP tools and Agent (defaults to claude-code)
> workspace mcp install
  • Explicit methods include claude-code, codex, and gemini-cli

    > workspace mcp install claude-code
    > workspace mcp install codex
    > workspace mcp install gemini-cli 
  • If updating, you will need to remove the previously existing MCP tools

    > workspace mcp uninstall claude-code
    > workspace mcp uninstall codex
    > workspace mcp uninstall gemini-cli 

About

Workspace management package for `workspaces` folder shared between different packages.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages