SimplArchive.Cli 0.51.0

Suggested Alternatives

Alcifra.Cli

There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global SimplArchive.Cli --version 0.51.0
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local SimplArchive.Cli --version 0.51.0
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=SimplArchive.Cli&version=0.51.0
                    
nuke :add-package SimplArchive.Cli --version 0.51.0
                    

saconsole — the SimplArchive administrative CLI

What SimplArchive is

SimplArchive is an open-source (Apache-2.0) enterprise document management system: an archive in which an organisation files, finds, controls and keeps its documents. It covers the essentials of the category:

  • Repositories and folders, with index data described by masks (typed fields per kind of document) and full version history.
  • Full-text search across content, names and index data.
  • Permissions per document, inherited down the tree, with groups, service accounts and clearance levels.
  • An approval workflow with a task inbox, escalation and reminders.
  • An append-only, hash-chained audit trail, with retention rules, legal holds and WORM storage.
  • Multi-tenancy, MFA and passkeys, and optional encryption at rest with smartcard-based reading.
  • Standard protocols, so an archive can be mounted as a drive (WebDAV) or read from a mail, calendar or address book client (IMAP, CalDAV, CardDAV).
  • A web client and a cross-platform desktop client, and industry modules that extend the core per tenant.

It runs as a container image beside PostgreSQL, S3-compatible object storage and a search engine, with a Helm chart for production. The project is also a showcase of how far an AI-assisted, senior-led development process can take an enterprise-grade system: https://github.com/HebelConsulting/SimplArchive

What saconsole does

saconsole administers a SimplArchive installation over its HTTP API, following the links the API advertises rather than composing addresses, so it keeps working when routes move. It is how an installation is set up and configured from a terminal or a script:

Command For
login, whoami Sign in (interactively, or as a service account) and show who you are acting as
tenant create, tenant standard-repository Provision a tenant with its first administrator; choose where SimplArchive files what it brings
tenant recovery-certificate show, set, replace The tenant's recovery certificate (ADR 0960): every offline export is also sealed to it, so an archive stays readable after its cards expire. Only the PUBLIC certificate is uploaded; set refuses where one is set, replace where none is. Without one, every offline export is refused (RECOVERY_CERTIFICATE_REQUIRED). show --pem prints the certificate for a script
tenant offline-cache show, set What the tenant allows the phone app's offline cache: the cache at all, what it may keep, how it unlocks and refreshes, how long it may stay unlocked. It binds the apps, which honour it; a phone cannot be forced
module list, module activate, module settings, module rebuild Activate industry modules with a vendor-signed licence, configure them, rebuild their read models
module action Invoke a module's action on a document; a value it reveals once (a credential) is written to a mode-600 file
module upload Upload a file through a module's upload link, such as a package or an app for its feed, found on the installation's root
repository create Create a repository, or find the one of that name; prints its id
certificates list, enrol, revoke, import Manage the reader certificates encrypted content is addressed to, including bulk import from a CA
acl set, grant, revoke Decide who may do what to a document
me certificate, intray previous A user's own certificate, and recovering intray content

Every command has --help. For example, to fix how phones unlock their offline cache and keep the rest:

saconsole tenant offline-cache set --unlock-mode Session --max-unlocked-minutes 10
saconsole tenant offline-cache show

Install and sign in

dotnet tool install --global SimplArchive.Cli

# before 0.47.0 the package was HebelConsulting.SimplArchive.Cli; replace it once:
#   dotnet tool uninstall --global HebelConsulting.SimplArchive.Cli

# interactive: approve the sign-in in your browser, then the session is set for this shell
eval "$(saconsole login --url https://archive.example.com)"
saconsole whoami

For unattended use, sign in as a tenant service account with saconsole login --client-id <id>, with the secret in SACONSOLE_CLIENT_SECRET (from the environment, never as an argument).

Requires the .NET 10 runtime. Source, documentation and issues: https://github.com/HebelConsulting/SimplArchive

Output

What is meant for a person goes to stderr, as plain lines (warning: and error: mark those levels); add --verbose for diagnostic detail. stdout carries only a command's result: the exports of login, the id of repository create and tenant standard-repository show, the one-time password of tenant create. So id=$(saconsole repository create --name Customers) captures exactly the id, and 2>/dev/null silences the rest.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.