Workspace Management

Overview

Chapi Assistant provides comprehensive workspace management to handle multiple .NET WPF projects simultaneously. Easily switch between projects, track their status, and maintain an organized development environment.

Workspace management is built on the IProjectRepository interface, which persists project information and preferences.

Loading Projects

Get All Projects

Retrieve all projects registered in your workspace:

var result = await loadProjectsUseCase.ExecuteAsync();

if (result.IsSuccess)
{
    var projects = result.Value;
    foreach (var project in projects)
    {
        Console.WriteLine($"{project.Name} - {project.Path}");
    }
}

Basic Usage
With Filtering
Error Handling

Load and display all projects:

var result = await loadProjectsUseCase.ExecuteAsync();

if (result.IsSuccess)
{
    var projects = result.Value;
    
    if (!projects.Any())
    {
        Console.WriteLine("No projects in workspace");
    }
    else
    {
        Console.WriteLine($"Found {projects.Count()} projects");
    }
}
else
{
    Console.WriteLine($"Error: {result.Error}");
}

Filter and organize loaded projects:

var result = await loadProjectsUseCase.ExecuteAsync();

if (result.IsSuccess)
{
    var projects = result.Value;
    
    // Filter by criteria
    var recentProjects = projects
        .Where(p => p.LastAccessedDate > DateTime.Now.AddDays(-7))
        .OrderByDescending(p => p.LastAccessedDate);
    
    var activeProjects = projects
        .Where(p => p.IsActive);
}

Handle loading errors gracefully:

try
{
    var result = await loadProjectsUseCase.ExecuteAsync();
    
    if (!result.IsSuccess)
    {
        // "Error cargando proyectos: {message}"
        LogError(result.Error);
        ShowDefaultWorkspace();
    }
}
catch (Exception ex)
{
    // Handle critical errors
    ShowErrorDialog(ex.Message);
}

Switching Projects

Switch Active Project

Change the currently active project in your workspace:

var result = await switchProjectUseCase.ExecuteAsync(
    projectPath: @"C:\Projects\CustomerApp"
);

if (result.IsSuccess)
{
    var project = result.Value;
    Console.WriteLine($"Switched to: {project.Name}");
}

projectPath

string

required

Full path to the project directory to switch to.

Validate Path

Ensures the project path is valid and the directory exists.

Retrieve Project

Fetches project information from the repository.

Update Active State

Marks the project as the currently active workspace.

Return Project

Returns the Project entity with all metadata.

Project Validation

Path Validation

// Validates:
// - Path is not null or whitespace
// - Directory exists on filesystem
// - Project is registered in workspace

if (string.IsNullOrWhiteSpace(projectPath))
    return Result<Project>.Fail("La ruta del proyecto no puede estar vacía");

if (!Directory.Exists(projectPath))
    return Result<Project>.Fail("El directorio no existe");

Project Existence

var project = await _projectRepository.GetProjectAsync(projectPath);

if (project == null)
    return Result<Project>.Fail("Proyecto no encontrado");

The project must be previously registered in the workspace.

Adding Projects

Register New Project

Add an existing project to your workspace:

var result = await addProjectUseCase.ExecuteAsync(
    projectPath: @"C:\Projects\ExistingApp"
);

if (result.IsSuccess)
{
    Console.WriteLine("Project added to workspace");
}

Add Single Project
Add Multiple Projects
With Validation

var result = await addProjectUseCase.ExecuteAsync(
    @"C:\Projects\MyApp"
);

if (result.IsSuccess)
{
    // Project is now tracked in workspace
    await RefreshProjectList();
}

var projectPaths = new[]
{
    @"C:\Projects\App1",
    @"C:\Projects\App2",
    @"C:\Projects\App3"
};

foreach (var path in projectPaths)
{
    var result = await addProjectUseCase.ExecuteAsync(path);
    
    if (!result.IsSuccess)
    {
        Console.WriteLine($"Failed to add {path}: {result.Error}");
    }
}

var projectPath = @"C:\Projects\NewApp";

// Pre-validate
if (!Directory.Exists(projectPath))
{
    Console.WriteLine("Directory does not exist");
    return;
}

var result = await addProjectUseCase.ExecuteAsync(projectPath);

if (!result.IsSuccess)
{
    // Possible errors:
    // - "La ruta del proyecto no puede estar vacía"
    // - "El directorio no existe"
    // - "Error agregando proyecto: {exception}"
    HandleError(result.Error);
}

When to Add Projects

After Cloning

Add projects after cloning from Git repositories.

Existing Projects

After Creation

Automatically added by CreateProjectUseCase.

Imported Projects

Add projects moved from other machines.

Removing Projects

Unregister Project

Remove a project from the workspace (doesn’t delete files):

var result = await removeProjectUseCase.ExecuteAsync(
    projectPath: @"C:\Projects\OldApp"
);

Removing a project from the workspace does not delete the project files. It only unregisters it from Chapi.

Project Indicators & Status

Update Project Status

Update project indicators like Git status, build status, etc.:

var result = await updateProjectIndicatorsUseCase.ExecuteAsync(
    projectPath: @"C:\Projects\MyApp"
);

This typically updates:

Git branch and status
Uncommitted changes count
Build status
Last modified time
Active status

Project indicators are refreshed automatically when switching projects or after Git operations.

Cloning Projects

Clone from Remote Repository

Clone a project and add it to the workspace:

var result = await cloneProjectUseCase.ExecuteAsync(
    remoteUrl: "https://github.com/myorg/myapp.git",
    localPath: @"C:\Projects\MyApp"
);

Clone Repository

Git clone from the remote URL to local path.

Automatically add the cloned project to workspace.

Update Indicators

Fetch initial project status and metadata.

Set as Active

Optionally switch to the newly cloned project.

Project Entity Structure

public class Project
{
    public string Path { get; set; }          // Full directory path
    public string Name { get; set; }          // Project name
    public bool IsActive { get; set; }        // Currently active?
    public DateTime LastAccessedDate { get; set; }
    public string CurrentBranch { get; set; } // Git branch
    public int UncommittedChanges { get; set; }
    public string BuildStatus { get; set; }
    // ... additional properties
}

Workspace Workflows

Daily Workflow
New Project Setup
Cleanup

// 1. Load all projects
var projects = await loadProjectsUseCase.ExecuteAsync();

// 2. Switch to project you want to work on
await switchProjectUseCase.ExecuteAsync(
    @"C:\Projects\CustomerApp"
);

// 3. Work on the project...
// Generate code, commit changes, etc.

// 4. Update project status
await updateProjectIndicatorsUseCase.ExecuteAsync(
    currentProjectPath
);

// 5. Switch to another project when needed
await switchProjectUseCase.ExecuteAsync(
    @"C:\Projects\OrderApp"
);

// Option 1: Create new project
var createResult = await createProjectUseCase.ExecuteAsync(
    new CreateProjectRequest(
        "NewApp",
        @"C:\Projects",
        "https://github.com/myorg/template.git"
    )
);
// Automatically added to workspace

// Option 2: Clone existing project
var cloneResult = await cloneProjectUseCase.ExecuteAsync(
    "https://github.com/myorg/app.git",
    @"C:\Projects\App"
);
// Automatically added to workspace

// Option 3: Add existing project
var addResult = await addProjectUseCase.ExecuteAsync(
    @"C:\Projects\ExistingApp"
);

// Get all projects
var result = await loadProjectsUseCase.ExecuteAsync();
var projects = result.Value;

// Find old or inactive projects
var oldProjects = projects
    .Where(p => p.LastAccessedDate < DateTime.Now.AddMonths(-6))
    .ToList();

// Remove from workspace
foreach (var project in oldProjects)
{
    await removeProjectUseCase.ExecuteAsync(project.Path);
}

// Optionally delete directories
// (Handle this carefully!)

Error Handling

var result = await loadProjectsUseCase.ExecuteAsync();

if (!result.IsSuccess)
{
    // "Error cargando proyectos: {message}"
    LogError(result.Error);
    
    // Fallback to empty workspace
    var emptyProjects = Enumerable.Empty<Project>();
}

Best Practices

Project Organization

Keep all projects in a consistent root directory (e.g., C:\Projects)
Use meaningful project names
Remove inactive projects from workspace
Regularly update project indicators

Switching Projects

Commit or stash changes before switching
Update project status after significant changes
Use project switch as a context boundary
Close unnecessary file handles before switching

Workspace Maintenance

Periodically review and clean up old projects
Keep workspace list manageable (< 20 active projects)
Archive completed projects
Back up workspace configuration

Performance

Load projects asynchronously on startup
Cache project list in memory
Update indicators on-demand, not constantly
Use lazy loading for project details

Project Lifecycle

Creation or Addition

Project is created via CreateProjectUseCase or added via AddProjectUseCase.

Registration

Project is registered in the workspace repository with metadata.

Active Development

Switch to project, make changes, commit, generate code, etc.

Status Updates

Indicators are updated after operations (commits, builds, etc.).

Archival or Removal

Remove from workspace when no longer needed (files remain).

Integration with Other Features

Project Creation

Created projects are automatically added to workspace

Git Management

Git operations update project indicators and status

Code Generation

Code generation operates on the active project

Deployment & Releases

Deploy Project Release

Deploy a project release to production:

var result = await deployProjectReleaseUseCase.ExecuteAsync(
    projectPath: @"C:\Projects\MyApp",
    version: "1.0.0",
    environment: "Production"
);

Project deployment is integrated with workspace management to track release history and status.

Project Creation

Create new projects that get added to workspace

Git Management

Manage version control for workspace projects

Get Started

Core Features

Guides

Configuration

Overview

Loading Projects

Get All Projects

Switching Projects

Switch Active Project

Project Validation

Adding Projects

Register New Project

When to Add Projects

After Cloning

Existing Projects

After Creation

Imported Projects

Removing Projects

Unregister Project

Project Indicators & Status

Update Project Status

Cloning Projects

Clone from Remote Repository

Project Entity Structure

Workspace Workflows

Error Handling

Best Practices

Project Lifecycle

Integration with Other Features

Project Creation

Git Management

Code Generation

Deployment & Releases

Deploy Project Release

Project Creation

Git Management

Build docs developers (and LLMs) love

Get Started

Core Features

Guides

Configuration

​Overview

​Loading Projects

​Get All Projects

​Switching Projects

​Switch Active Project

​Project Validation

​Adding Projects

​Register New Project

​When to Add Projects

After Cloning

Existing Projects

After Creation

Imported Projects

​Removing Projects

​Unregister Project

​Project Indicators & Status

​Update Project Status

​Cloning Projects

​Clone from Remote Repository

​Project Entity Structure

​Workspace Workflows

​Error Handling

​Best Practices

​Project Lifecycle

​Integration with Other Features

Project Creation

Git Management

Code Generation

​Deployment & Releases

​Deploy Project Release

​Related Features

Project Creation

Git Management

Build docs developers (and LLMs) love

Overview

Loading Projects

Get All Projects

Switching Projects

Switch Active Project

Project Validation

Adding Projects

Register New Project

When to Add Projects

Removing Projects

Unregister Project

Project Indicators & Status

Update Project Status

Cloning Projects

Clone from Remote Repository

Project Entity Structure

Workspace Workflows

Error Handling

Best Practices

Project Lifecycle

Integration with Other Features

Deployment & Releases

Deploy Project Release

Related Features