E4S Infrastructure Documentation Documentation online
E4S INFRASTRUCTURE DOCUMENTATION

CLI Reference

Complete E4S command-line reference.

Primary E4S CLI

The e4s command is the main infrastructure operations interface installed with E4S Infrastructure.

Command What it does Notes
e4s helpDisplay the E4S command reference.
e4s versionDisplay application, Python and database version information.
e4s statusShow Web, Worker and Agent API systemd state.
e4s healthQuery Web and Agent API health endpoints.
e4s doctorRun combined service, health, port, Nginx, Redis, Feature Guard and disk diagnostics.
e4s routes [filter]Read the application OpenAPI document and list API routes.
e4s portsDisplay important listening ports and processes.
e4s restart webRestart only the Web service.
e4s restart workerRestart only the Worker.
e4s restart agentRestart only the Agent API.
e4s restart allRestart all primary E4S runtime services.
e4s start [web|worker|agent|all]Start selected E4S services.
e4s stop [web|worker|agent|all]Stop selected E4S services.
e4s logs web [lines]Show Web service journal output.
e4s logs worker [lines]Show Worker service journal output.
e4s logs agent [lines]Show Agent API journal output.
e4s backupRun the installed E4S backup workflow.
e4s db shellOpen the PostgreSQL shell for the E4S database.
e4s db sizeDisplay database size information.
e4s db activityDisplay current PostgreSQL activity.
e4s db vacuum-analyzeRun PostgreSQL VACUUM ANALYZE maintenance.
e4s redis statusDisplay Redis service status.
e4s redis infoDisplay Redis runtime information.
e4s redis cliOpen redis-cli.
e4s nginx testRun nginx configuration validation.
e4s nginx reloadReload Nginx after a valid configuration change.
e4s nginx dumpDisplay effective Nginx configuration.
e4s feature-guard verifyVerify protected application files against the accepted baseline.
e4s feature-guard baselineReview changed protected files before accepting a new baseline.Use only after approved source changes.
e4s release-checkRun release/runtime consistency checks.
e4s cleanupRun installed platform cleanup routines.
e4s license statusDisplay current license enforcement state.
e4s license entitlementDisplay the current signed feature and limit entitlement.
e4s license refreshRequest a fresh entitlement from the License Authority.
e4s license fingerprintDisplay the machine/license fingerprint.
e4s license feature NAMEQuery one named license feature.
e4s license limit NAMEQuery one named license limit.
e4s app-cli <args...>Pass arguments to the application CLI.
e4s tools listList installed E4S operational helper tools.
e4s tools run NAMEExecute a named E4S helper tool.
e4s cert-checkRun the installed certificate checker or Certbot certificate listing.
e4s agent-healthQuery Agent API health and recent agent traffic.

License Client commands

CommandPurpose
e4s-license-client statusCurrent license and enforcement status.
e4s-license-client entitlementFull local signed entitlement.
e4s-license-client refreshRefresh signed policy from the authority.
e4s-license-client feature NAMECheck one feature switch.
e4s-license-client limit NAMERead one resource limit.

Systemd equivalents

Inspect services
systemctl status e4s-web.service
systemctl status e4s-agent-api.service
systemctl status e4s-worker.service
systemctl status e4s-license-client.service
Read logs
journalctl -u e4s-web.service -n 200 --no-pager
journalctl -u e4s-agent-api.service -n 200 --no-pager
journalctl -u e4s-worker.service -n 200 --no-pager

Build and distribution operator commands

Operator-only tooling

These commands are intended for the E4S build/distribution environment, not normal customer installations.

CommandPurpose
e4s distribution statusDisplay local platform, Update Authority and Layer1 distribution status.
e4s distribution editionsDisplay configured public edition data.
e4s distribution build VERSION betaBuild Universal installer output.
e4s distribution publish VERSION betaUpload, sign and publish prepared Universal installers.
e4s distribution ship VERSION betaBuild and publish the complete release flow supported by the distribution tooling.