cli/docs/core/workspace.md

title
Core.Workspace

Core.Workspace

Short: Manages user workspaces.

Overview

Provides functionality for creating, switching, and managing isolated user workspaces, including file storage and cryptographic operations within those workspaces.

Setup

import (
  "github.com/Snider/Core"
  "github.com/Snider/Core/workspace"
  "github.com/Snider/Core/io"
)

workspaceService, err := workspace.New()
if err != nil {
  // handle error
}
app := core.New(
  core.WithService(workspaceService),
  core.WithServiceLock(),
)

// Example of dynamic dependency injection (used with core.WithService)
// If using dynamic injection, the io.Medium dependency would be resolved
// during ServiceStartup, typically by another service providing it.
// app := core.New(
//   core.WithService(workspace.Register),
//   core.WithServiceLock(),
// )

Use

• Create a new workspace: ws.CreateWorkspace("my-project", "my-password")
• Switch to an existing workspace: ws.SwitchWorkspace("my-project-id")
• Get a file from the active workspace: ws.WorkspaceFileGet("config.json")
• Set a file in the active workspace: ws.WorkspaceFileSet("data.txt", "some content")

API

• New(medium io.Medium) (*Service, error)
• Register(c *core.Core) (any, error)
• (s *Service) HandleIPCEvents(c *core.Core, msg core.Message) error
• (s *Service) ServiceStartup(context.Context, application.ServiceOptions) error
• (s *Service) CreateWorkspace(identifier, password string) (string, error)
• (s *Service) SwitchWorkspace(name string) error
• (s *Service) WorkspaceFileGet(filename string) (string, error)
• (s *Service) WorkspaceFileSet(filename, content string) (string, error)

Notes

• Workspaces are obfuscated and secured with OpenPGP.
• Integrates with Core.Config for workspace directory management.