README
¶
github.com/ruf-dev/artel
generated with love for coding by RedSock CLI
License
Artel is free software licensed under the GNU AGPL-3.0. This means you're free to use, modify, and redistribute it — including running a modified version as a hosted service — as long as you make the corresponding source available to your users under the same license. See TRADEMARK.md for the separate policy on use of the "Artel" name and logo.
Running locally
For a standard multi-container dev setup, see docker-compose.yaml.
For an all-in-one container (Postgres, CouchDB, Garage and the app bundled together — handy for personal/self-hosted use), see docs/omnibus.md.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
service
command
SPDX-License-Identifier: AGPL-3.0-only
|
SPDX-License-Identifier: AGPL-3.0-only |
|
internal
|
|
|
api/server/artel_api
Package artel_api is a reverse proxy.
|
Package artel_api is a reverse proxy. |
|
clients/anthropic
Package anthropic is a thin wrapper around the official Anthropic SDK (github.com/anthropics/anthropic-sdk-go), used to validate a user-supplied API key (via ListModels, a zero-token metadata call) and to run single-turn, non-streaming completions (via Complete) for the tract engine's "Call LLM" step.
|
Package anthropic is a thin wrapper around the official Anthropic SDK (github.com/anthropics/anthropic-sdk-go), used to validate a user-supplied API key (via ListModels, a zero-token metadata call) and to run single-turn, non-streaming completions (via Complete) for the tract engine's "Call LLM" step. |
|
clients/openai
Package openai is a thin wrapper around the official OpenAI SDK (github.com/openai/openai-go), used to validate a user-supplied API key (via ListModels, a zero-token metadata call) and to run single-turn, non-streaming completions (via Complete) for the tract engine's "Call LLM" step.
|
Package openai is a thin wrapper around the official OpenAI SDK (github.com/openai/openai-go), used to validate a user-supplied API key (via ListModels, a zero-token metadata call) and to run single-turn, non-streaming completions (via Complete) for the tract engine's "Call LLM" step. |
|
clients/postgres
Code generated by RedSock CLI.
|
Code generated by RedSock CLI. |
|
clients/vaultbucket
Package vaultbucket resolves the storage.BinaryStore backing a vault's non-markdown content — shared by the MCP vault-tool executor and the notes service's folder export/import/delete methods so the S3-vs-CouchDB-adapter decision lives in one place.
|
Package vaultbucket resolves the storage.BinaryStore backing a vault's non-markdown content — shared by the MCP vault-tool executor and the notes service's folder export/import/delete methods so the S3-vs-CouchDB-adapter decision lives in one place. |
|
clients/vaultpg
Package vaultpg is the client for per-vault Postgres databases: building connection strings for a domain.PostgresInstance/vault database+role pair, running the admin-side DDL that provisions a vault's role+database (AdminClient), and caching the tenant-side *sql.DB connections the MCP executor queries through (ConnPool).
|
Package vaultpg is the client for per-vault Postgres databases: building connection strings for a domain.PostgresInstance/vault database+role pair, running the admin-side DDL that provisions a vault's role+database (AdminClient), and caching the tenant-side *sql.DB connections the MCP executor queries through (ConnPool). |
|
clients/workbenchdocker
Package workbenchdocker is a thin typed wrapper around the Docker Engine SDK (github.com/docker/docker/client), used to create/start/stop/remove the containers and volumes that back a single workbench (a per-user sandbox running the `claude` CLI inside a persistent tmux session).
|
Package workbenchdocker is a thin typed wrapper around the Docker Engine SDK (github.com/docker/docker/client), used to create/start/stop/remove the containers and volumes that back a single workbench (a per-user sandbox running the `claude` CLI inside a persistent tmux session). |
|
config
Package config loads and parses the application's runtime configuration.
|
Package config loads and parses the application's runtime configuration. |
|
middleware/requesthost
Package requesthost threads the public-facing host of an inbound HTTP request from the transport layer into the service layer, mirroring the user_context package's pattern.
|
Package requesthost threads the public-facing host of an inbound HTTP request from the transport layer into the service layer, mirroring the user_context package's pattern. |
|
repository/pg/repos/dockerhosts
Package dockerhosts is the pure-DB layer for the admin-managed pool of Docker daemons backing per-vault workbench containers — see docs/workbench/02_docker_topology.md.
|
Package dockerhosts is the pure-DB layer for the admin-managed pool of Docker daemons backing per-vault workbench containers — see docs/workbench/02_docker_topology.md. |
|
repository/pg/repos/triggerpresets
Package triggerpresets is the pure-DB read layer for the trigger_presets catalog table (see migration 038_trigger_presets_and_links.sql) — the webhook trigger presets shown in the "Add trigger" picker (gitlab_push, generic, ...), replacing the hardcoded Go slice that used to live in internal/service/v1/tract.
|
Package triggerpresets is the pure-DB read layer for the trigger_presets catalog table (see migration 038_trigger_presets_and_links.sql) — the webhook trigger presets shown in the "Add trigger" picker (gitlab_push, generic, ...), replacing the hardcoded Go slice that used to live in internal/service/v1/tract. |
|
service/v1/adminsettings
Package adminsettings implements AdminSystemSettingsService — an administrator's view over the same single-row global instance configuration the first-run setup wizard (internal/service/v1/setupwizard) edits pre-setup, exposed post-setup for an admin to revisit.
|
Package adminsettings implements AdminSystemSettingsService — an administrator's view over the same single-row global instance configuration the first-run setup wizard (internal/service/v1/setupwizard) edits pre-setup, exposed post-setup for an admin to revisit. |
|
service/v1/dockerhosts
Package dockerhosts implements service.DockerHostService: admin CRUD over the pool of Docker daemons that back per-vault workbench containers — see docs/workbench/02_docker_topology.md.
|
Package dockerhosts implements service.DockerHostService: admin CRUD over the pool of Docker daemons that back per-vault workbench containers — see docs/workbench/02_docker_topology.md. |
|
service/v1/postgresinstances
Package postgresinstances is the admin CRUD service for the shared pool of Postgres servers (admin pool or BYOK) that per-vault databases are provisioned on — mirrors internal/service/v1/s3instances.
|
Package postgresinstances is the admin CRUD service for the shared pool of Postgres servers (admin pool or BYOK) that per-vault databases are provisioned on — mirrors internal/service/v1/s3instances. |
|
service/v1/public_docs
Package public_docs implements the anonymous, auth-exempt read surface backing PublicDocsAPI (see internal/api/server/artel_api/public_docs_grpc.pb.go's doc comment and docs/architecture.md).
|
Package public_docs implements the anonymous, auth-exempt read surface backing PublicDocsAPI (see internal/api/server/artel_api/public_docs_grpc.pb.go's doc comment and docs/architecture.md). |
|
service/v1/setupwizard
Package setupwizard implements the first-run setup wizard — see internal/service/interfaces.go's SetupWizardService doc comment for the flow this drives.
|
Package setupwizard implements the first-run setup wizard — see internal/service/interfaces.go's SetupWizardService doc comment for the flow this drives. |
|
service/v1/tasktracker
Package tasktracker backs the TaskTrackersAPI wire contract (unchanged) on top of the generic external_connections + MoM path instead of a dedicated task_trackers table/client.
|
Package tasktracker backs the TaskTrackersAPI wire contract (unchanged) on top of the generic external_connections + MoM path instead of a dedicated task_trackers table/client. |
|
service/v1/tract/script
Package script is the pluggable execution backend for Tract "script" steps.
|
Package script is the pluggable execution backend for Tract "script" steps. |
|
service/v1/workbench
Package workbench implements service.WorkbenchService: it manages the per-vault Docker container backing a vault's cloud workbench.
|
Package workbench implements service.WorkbenchService: it manages the per-vault Docker container backing a vault's cloud workbench. |
|
pkg
|
|
|
app
Package app is the public entry point for embedding artel as a library.
|
Package app is the public entry point for embedding artel as a library. |
Click to show internal directories.
Click to hide internal directories.