FICCDocumentation
nightly prerelease / Version 0.3.0.dev1Project website
Reference library
Start here
On this page
  1. Start here
  2. Manual library
  3. Terms used in the manuals
  4. Find a task
  5. Conventions

Documentation#

Install and operate a console for Linux clusters and managed Mac nodes. FICC connects to approved SSH profiles and contributors, with project access, workload queues and dataset pipelines. The controller retains identities, approvals and operation receipts. Remote browser access requires explicit HTTPS and identity-service configuration. Start with the guides below, then use the task manuals as needed.

The online documentation provides page contents, command copying and a search index that runs in your browser.

Start here#

  1. Read the architecture and security model.
  2. Choose a Linux package, Linux source installation, or native macOS installation.
  3. Try the demonstration console with separate state.
  4. Connect a machine and inspect its pinned identity.
  5. Set up normal startup and maintenance.
  6. Choose appearance and themes, or design and share a custom theme.

The source installer and binary payload supply 17 separately built provider wheels. Their presence does not configure external services, enroll contributors or grant access. Follow the relevant workflow guide before enabling a provider.

Manual library#

Order Manual Subject
01 Architecture Controller, node helpers, trust and state ownership.
02 Installation Requirements, build, demo and first machine enrollment.
03 Operation Desktop startup, service settings, trust changes and upgrades.
04 Managed jobs Command previews, resource controls, output and recovery.
05 Files Registered roots, explorer tables, file changes and transfers.
06 Terminals Interactive SSH, tmux, tiling, fullscreen and session lifetime.
07 Coding agents Runtime profiles, native adapters, inbox tools and authority.
07a Agent observations Scoped inventory and resource readings for existing agent sessions.
07b GPU observations NVIDIA readings, generic AMDGPU readings and hardware qualification limits.
08 Agent bus Run membership, explicit delivery, receipts and portable history.
09 Backup and restore Consistent private state bundles and verified restore.
10 History archives Explicit retention, export and capacity recovery.
11 Local API Authentication, scopes, endpoints and request contracts.
12 Testing Source, Python, SSH, browser and installed-system checks.
13 Dependencies Locked components, bundled assets and their licences.
14 Linux packages Binary formats, verification, first startup, upgrade and removal.
15 Runtime modules Inspect packages, select grants, enable, update and remove modules.
16 Workspaces Saved panels, tiling, separate windows, notes and file editing.
17 Workspace sound Local playback, master controls and window ownership.
18 Remote displays Input release, nested fullscreen and display limits.
19 Native viewer runtime Build, install, platform checks, licenses and corresponding sources.
20 Libvirt provider VM inventory, confirmed lifecycle requests and VNC prerequisites.
21 Containers Docker, Podman and Kubernetes profiles, operations and recovery.
22 Module SDK Five language families, package tools, protocols and host components.
23 System administration Systemd profiles, service actions, logs and confirmed power requests.
24 Proxmox provider Pinned provider builds, VM tasks and recovery.
25 Windows endpoints Registered JEA commands, private credentials and separate display connections.
26 Provider adapter SDK Runtime provider packages, account grants and operation receipts.
27 VirtualBox provider Account-bound native adapter, local IPC and display setup.
28 Module sandbox setup Optional AppArmor policy, installation checks and removal.
29 System power policy Optional group-scoped shutdown and restart permissions.
30 Identities and projects Local user identities, project workspace ownership, membership and recovery.
31 Controller state storage SQLite, optional PostgreSQL driver, verified transport, migration and recovery.
32 Runtime policies Signed packages, role assignments, effective access and recovery.
33 Remote access HTTPS gateway, approved identities, MFA and revocation.
34 Contributor connections Private CA setup, invitations, independent key approval, node leases and recovery.
35 OpenSSH certificate trust Installation-approved CAs, principals, user certificates, KRLs and live connection checks.
36 Certificate provider SDK Trusted runtime authority providers, issuance contracts and credential boundaries.
37 Contributor workloads Project queues, placement, output, cancellation and uncertain outcome recovery.
38 Contributor execution Local consent, enforced resources, isolated runtimes and executor installation.
39 Scheduler SDK Separately installed scheduling and project concurrency providers.
40 Datasets Immutable project manifests, source digests, explicit schemas and provenance.
41 Artifact SDK Runtime filesystem providers, source binding and bounded dataset consumption.
42 Data sources Approved connections, registered queries, dataset exports and resumable object publication.
43 Data provider SDK Installable source/format contracts, bounded streams and customer REST extensions.
44 Dataset inspection Optional local scanning, recorded coverage, quarantine, sensitivity and explicit exemptions.
45 Inspection SDK Separately installed local scanner packages and immutable file receipts.
46 Secret storage Encrypted references, private provisioning, rotation, migration and key recovery.
47 Secret provider SDK Runtime secret contracts, revision checks and failure behavior.
48 Durable audit delivery Separate destination custody, acknowledgments, retention gaps and required admission.
49 Audit provider SDK Bounded append batches, strict acknowledgments and recovery.
50 Executor SDK Contributor runtime isolation, staged inputs and retained output contracts.

Terms used in the manuals#

Term Meaning
Controller The local FICC service and its canonical database.
Managed node An enrolled machine reached through an approved SSH identity.
Contributor A separately approved machine with an outbound TLS connection and a current certificate lease.
Dataset An immutable project manifest binding registered file versions, complete digests, schema and provenance.
Workload attempt One fenced contributor execution with its own lease, observed outcome and retained storage.
SSH profile A locally approved SSH alias used for connection and enrollment.
Agent profile An exact installed command, adapter and working directory on one node.
File root A registered directory with explicit permitted actions.
Run A host-owned group of enrolled agents and their bus messages.
Receipt Evidence of a delivery stage, separate from task completion.
Reconcile Inspect a saved operation identity after its outcome became uncertain.
Archive Explicitly preserve completed history before reclaiming active capacity.
Module package An immutable runtime archive identified by its exact digest.
Module panel A package instance with saved data and a specific target selection.
Workspace A saved group of module panels.
Workspace view One window's panel arrangement, separate from shared workspace data.

Find a task#

Task Start here
Install a binary package Linux packages
Try FICC without touching nodes Demo mode
Start from the application menu User service
Open several terminals Terminal workspace
Register a coding agent Coding agents
Assist with FICC from an external coding agent External agent assistance
Contact another agent Agent bus
Prepare a controller upgrade Operation and backup
Reclaim retained capacity History archives and closed bus runs
Add a module Package inspection and grants
Use multiple monitors Workspace windows
Edit a system file Registered-root editor
Release VM keyboard input Remote display controls
Invite a remote contributor Contributor enrollment
Submit compute to contributors Contributor workloads
Export a source query for a workload Data sources and datasets
Publish a workload result Output publication
Inspect dataset coverage and restrictions Dataset inspection
Provision or rotate a source credential Secret storage
Configure an independent audit destination Durable audit delivery
Inspect health and download diagnostics Operational status
Configure SSH certificate trust OpenSSH certificates

Conventions#

Runtime access policies cover publisher trust, installation, role assignments, effective access and recovery.

Commands use generic machine aliases and opaque IDs. Replace those values with the identities shown by the local console. Keep credentials in protected files; never put them in command arguments, repository text or shared captures.

Each guide states its own prerequisites, effects and limits. A preview does not perform an operation. A receipt does not prove completed work. Active and uncertain records remain retained until their outcome can be resolved.

Return to the project README

Managed model and service workflows: Inference.

Cluster federation covers HyperNet setup, pairing, grants, remote inference and verified model ranges.

FICC / DocumentationBack to top

Search documentation

Press Escape to close

Loading search...

    Reading appearance

    Choose colours, surfaces and text independently. These settings are saved for this documentation site in this browser.

    Flat surfaces remove decorative materials. Typography is a separate choice. Increased contrast uses the Contrast palette. System forced colours always take precedence.