Atlas project concept

snipeit_gui

Provide a technician-friendly interface for asset lookups, updates, and bulk workflows. It ingests Serial numbers, CSV text, (future) Snipe-IT API credentials and produces CSV exports (planned), API updates (planned).

Type
Field Tool
Lifecycle
Maintenance
Last touched
2025-03-23
Visibility
Public

Purpose

Provide a technician-friendly interface for asset lookups, updates, and bulk workflows.

Current state

Last touched: 2025-03-23. Functionality and completeness: UI shell exists; API operations are not implemented.

Next step

Add baseline automated tests to cover critical flows; Add CI pipeline for build/test/lint; Document deployment/runtime environment (or add Dockerfile); Document interfaces (CLI flags, API endpoints, file formats); Add structured logging and basic health checks.

Interfaces

Inputs
  • Serial numbers, CSV text, (future) Snipe-IT API credentials
  • Bulk CSV text (planned)
Outputs
  • CSV exports (planned), API updates (planned)
  • Console output (prototype)
  • CSV files (planned)

Reality to Action trace

Reality Ingestion

Not in scope.

Canonical Storage

Not in scope.

Automation Engines

Not in scope.

Human Interfaces

Contributes in this stage.

Operational Adoption

Not in scope.

Core workflow

TBD. Document the 5-10 steps that define the core workflow.

Artifacts

  • Not defined yet; prototype UI does not enforce schemas

Operational notes

Constraints and scars

  • Prototype-only; UI flows do not yet talk to the API or produce CSV outputs.

Reliability posture

Failure modes and safe behavior: Incomplete actions are currently no-ops beyond logging. Idempotency / retries / batching behavior: Not applicable until API actions are implemented.

Observability

  • Logs: stdout in prototype
  • Metrics/health checks: None documented
  • Logs: stdout for simulated actions; no structured logging in prototype.

Security and privacy

Future API integration will require tokens; plan secure storage before production use.

Dependencies

Upstream
  • Snipe-IT API (planned)

Ownership

Owners

Josh Barton

Users

Josh Barton (owner)

snipeit_gui

Architecture & Major Components

  • High-level diagram (text):

    • GUI inputs -> in-memory state -> (future) API client -> outputs
  • Entry points: src/main.rs

  • Top-level folders: src

  • Key abstractions: UI state machine for single vs bulk mode, placeholder action handlers

Setup / Build / Run

  • Build system(s): Cargo.