File reference
Generated reference. The build creates this page from the release source.
The scripts/docsgen generator writes this page from the source code. Do not edit this page. To update it, run make docs-generate.
This page lists the files and directories that Starport can use with the default configuration. A path that starts with ~ is in your home directory. A setting in the Selectors column can move the path. Starport creates only the files that the selected backend and operation use. To see the report for your configuration, run starport config paths --files.
| Root | Path |
|---|
| config | ~/.config/starport |
| data | ~/.local/share/starport |
| state | ~/.local/state/starport |
| cache | ~/.cache/starport |
| ID | Kind | Path | Availability | Access | Selectors |
|---|
configuration | file | ~/.config/starport/config.env | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_CONFIG_DIR, STARPORT_CONFIG_ACCESS |
badger | tree | ~/.local/share/starport/badger | available | owner-only | STARPORT_STORAGE_BADGER_PATH |
setup-transaction | tree | ~/.config/starport/.starport-setup | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_STORAGE_BADGER_PATH |
setup-config-publications | tree | ~/.config/starport/.record-publications | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_STORAGE_BADGER_PATH |
setup-storage-guard | tree | ~/.local/share/starport/.starport-setup-badger | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_STORAGE_BADGER_PATH |
setup-database-stage | patterns | ~/.local/share/starport | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_STORAGE_BADGER_PATH |
config-operation-journal | file | ~/.config/starport/.starport-config-operations.json | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_CONFIG_MANAGEMENT |
sqlite | file | ~/.local/share/starport/sqlite/starport.db | available | owner-only | STARPORT_STORAGE_SQL_SQLITE_PATH |
sqlite-wal | file | ~/.local/share/starport/sqlite/starport.db-wal | available | owner-only | STARPORT_STORAGE_SQL_SQLITE_PATH |
sqlite-shm | file | ~/.local/share/starport/sqlite/starport.db-shm | available | owner-only | STARPORT_STORAGE_SQL_SQLITE_PATH |
sqlite-journal | file | ~/.local/share/starport/sqlite/starport.db-journal | available | owner-only | STARPORT_STORAGE_SQL_SQLITE_PATH |
files | tree | ~/.local/share/starport/files | available | owner-only | STARPORT_FILES_PATH |
local-token | file | ~/.local/share/starport/local-admin-token.json | available | owner-only | |
local-token-lock | file | ~/.local/share/starport/local-admin-token.json.lock | available | owner-only | |
welcome-stamp | file | ~/.local/share/starport/welcomed | available | owner-only | |
baseline | tree | ~/.local/share/starport/catalog/baseline | available | public-read | |
baseline-recovery | tree | ~/.local/share/starport/catalog/baseline/.starmap-baseline | available | owner-only | |
runtime-evidence | tree | ~/.local/state/starport/catalog/runtime/default | available | owner-only | |
credential-policy | tree | ~/.local/state/starport/credentials/catalog/default | available | owner-only | STARPORT_STATE_ROOT, STARPORT_INSTANCE_ID |
inference-credential-policy | tree | ~/.local/state/starport/credentials/inference/default | available | owner-only | STARPORT_STATE_ROOT, STARPORT_INSTANCE_ID |
workspace | tree | Not selected | disabled | deployment-controlled | STARPORT_CATALOG_WORKSPACE_PATH |
tls-certificate | file | Not selected | disabled | deployment-controlled | |
tls-key | file | Not selected | disabled | owner-only | |
cache-ca | file | Not selected | disabled | deployment-controlled | STARPORT_CACHE_CA_FILE |
valkey-ca | file | Not selected | disabled | deployment-controlled | STARPORT_STORAGE_VALKEY_CA_FILE |
logs | file | Not selected | planned | owner-only | STARPORT_LOGGING_FILE_PATH |
source-http | tree | ~/.cache/starport/models.dev | available | deployment-controlled | STARPORT_CACHE_DIR, STARPORT_CATALOG_ACQUISITION_SOURCES |
source-checkout | tree | ~/.cache/starport/sources/models.dev-git | disabled | deployment-controlled | STARPORT_CACHE_DIR, STARPORT_CATALOG_ACQUISITION_SOURCES |
| Root | Path |
|---|
| config | ~/Library/Application Support/starport/config |
| data | ~/Library/Application Support/starport/data |
| state | ~/Library/Application Support/starport/state |
| cache | ~/Library/Caches/starport |
| ID | Kind | Path | Availability | Access | Selectors |
|---|
configuration | file | ~/Library/Application Support/starport/config/config.env | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_CONFIG_DIR, STARPORT_CONFIG_ACCESS |
badger | tree | ~/Library/Application Support/starport/data/badger | available | owner-only | STARPORT_STORAGE_BADGER_PATH |
setup-transaction | tree | ~/Library/Application Support/starport/config/.starport-setup | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_STORAGE_BADGER_PATH |
setup-config-publications | tree | ~/Library/Application Support/starport/config/.record-publications | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_STORAGE_BADGER_PATH |
setup-storage-guard | tree | ~/Library/Application Support/starport/data/.starport-setup-badger | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_STORAGE_BADGER_PATH |
setup-database-stage | patterns | ~/Library/Application Support/starport/data | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_STORAGE_BADGER_PATH |
config-operation-journal | file | ~/Library/Application Support/starport/config/.starport-config-operations.json | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_CONFIG_MANAGEMENT |
sqlite | file | ~/Library/Application Support/starport/data/sqlite/starport.db | available | owner-only | STARPORT_STORAGE_SQL_SQLITE_PATH |
sqlite-wal | file | ~/Library/Application Support/starport/data/sqlite/starport.db-wal | available | owner-only | STARPORT_STORAGE_SQL_SQLITE_PATH |
sqlite-shm | file | ~/Library/Application Support/starport/data/sqlite/starport.db-shm | available | owner-only | STARPORT_STORAGE_SQL_SQLITE_PATH |
sqlite-journal | file | ~/Library/Application Support/starport/data/sqlite/starport.db-journal | available | owner-only | STARPORT_STORAGE_SQL_SQLITE_PATH |
files | tree | ~/Library/Application Support/starport/data/files | available | owner-only | STARPORT_FILES_PATH |
local-token | file | ~/Library/Application Support/starport/data/local-admin-token.json | available | owner-only | |
local-token-lock | file | ~/Library/Application Support/starport/data/local-admin-token.json.lock | available | owner-only | |
welcome-stamp | file | ~/Library/Application Support/starport/data/welcomed | available | owner-only | |
baseline | tree | ~/Library/Application Support/starport/data/catalog/baseline | available | public-read | |
baseline-recovery | tree | ~/Library/Application Support/starport/data/catalog/baseline/.starmap-baseline | available | owner-only | |
runtime-evidence | tree | ~/Library/Application Support/starport/state/catalog/runtime/default | available | owner-only | |
credential-policy | tree | ~/Library/Application Support/starport/state/credentials/catalog/default | available | owner-only | STARPORT_STATE_ROOT, STARPORT_INSTANCE_ID |
inference-credential-policy | tree | ~/Library/Application Support/starport/state/credentials/inference/default | available | owner-only | STARPORT_STATE_ROOT, STARPORT_INSTANCE_ID |
workspace | tree | Not selected | disabled | deployment-controlled | STARPORT_CATALOG_WORKSPACE_PATH |
tls-certificate | file | Not selected | disabled | deployment-controlled | |
tls-key | file | Not selected | disabled | owner-only | |
cache-ca | file | Not selected | disabled | deployment-controlled | STARPORT_CACHE_CA_FILE |
valkey-ca | file | Not selected | disabled | deployment-controlled | STARPORT_STORAGE_VALKEY_CA_FILE |
logs | file | Not selected | planned | owner-only | STARPORT_LOGGING_FILE_PATH |
source-http | tree | ~/Library/Caches/starport/models.dev | available | deployment-controlled | STARPORT_CACHE_DIR, STARPORT_CATALOG_ACQUISITION_SOURCES |
source-checkout | tree | ~/Library/Caches/starport/sources/models.dev-git | disabled | deployment-controlled | STARPORT_CACHE_DIR, STARPORT_CATALOG_ACQUISITION_SOURCES |
| Root | Path |
|---|
| config | %AppData%\starport |
| data | %LocalAppData%\starport\data |
| state | %LocalAppData%\starport\state |
| cache | %LocalAppData%\starport\cache |
| ID | Kind | Path | Availability | Access | Selectors |
|---|
configuration | file | %AppData%\starport\config.env | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_CONFIG_DIR, STARPORT_CONFIG_ACCESS |
badger | tree | %LocalAppData%\starport\data\badger | available | owner-only | STARPORT_STORAGE_BADGER_PATH |
setup-transaction | tree | %AppData%\starport\.starport-setup | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_STORAGE_BADGER_PATH |
setup-config-publications | tree | %AppData%\starport\.record-publications | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_STORAGE_BADGER_PATH |
setup-storage-guard | tree | %LocalAppData%\starport\data\.starport-setup-badger | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_STORAGE_BADGER_PATH |
setup-database-stage | patterns | %LocalAppData%\starport\data | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_STORAGE_BADGER_PATH |
config-operation-journal | file | %AppData%\starport\.starport-config-operations.json | available | owner-only | STARPORT_CONFIG_FILE, STARPORT_CONFIG_MANAGEMENT |
sqlite | file | %LocalAppData%\starport\data\sqlite\starport.db | available | owner-only | STARPORT_STORAGE_SQL_SQLITE_PATH |
sqlite-wal | file | %LocalAppData%\starport\data\sqlite\starport.db-wal | available | owner-only | STARPORT_STORAGE_SQL_SQLITE_PATH |
sqlite-shm | file | %LocalAppData%\starport\data\sqlite\starport.db-shm | available | owner-only | STARPORT_STORAGE_SQL_SQLITE_PATH |
sqlite-journal | file | %LocalAppData%\starport\data\sqlite\starport.db-journal | available | owner-only | STARPORT_STORAGE_SQL_SQLITE_PATH |
files | tree | %LocalAppData%\starport\data\files | available | owner-only | STARPORT_FILES_PATH |
local-token | file | %LocalAppData%\starport\data\local-admin-token.json | available | owner-only | |
local-token-lock | file | %LocalAppData%\starport\data\local-admin-token.json.lock | available | owner-only | |
welcome-stamp | file | %LocalAppData%\starport\data\welcomed | available | owner-only | |
baseline | tree | %LocalAppData%\starport\data\catalog\baseline | available | public-read | |
baseline-recovery | tree | %LocalAppData%\starport\data\catalog\baseline\.starmap-baseline | available | owner-only | |
runtime-evidence | tree | %LocalAppData%\starport\state\catalog\runtime\default | available | owner-only | |
credential-policy | tree | %LocalAppData%\starport\state\credentials\catalog\default | available | owner-only | STARPORT_STATE_ROOT, STARPORT_INSTANCE_ID |
inference-credential-policy | tree | %LocalAppData%\starport\state\credentials\inference\default | available | owner-only | STARPORT_STATE_ROOT, STARPORT_INSTANCE_ID |
workspace | tree | Not selected | disabled | deployment-controlled | STARPORT_CATALOG_WORKSPACE_PATH |
tls-certificate | file | Not selected | disabled | deployment-controlled | |
tls-key | file | Not selected | disabled | owner-only | |
cache-ca | file | Not selected | disabled | deployment-controlled | STARPORT_CACHE_CA_FILE |
valkey-ca | file | Not selected | disabled | deployment-controlled | STARPORT_STORAGE_VALKEY_CA_FILE |
logs | file | Not selected | planned | owner-only | STARPORT_LOGGING_FILE_PATH |
source-http | tree | %LocalAppData%\starport\cache\models.dev | available | deployment-controlled | STARPORT_CACHE_DIR, STARPORT_CATALOG_ACQUISITION_SOURCES |
source-checkout | tree | %LocalAppData%\starport\cache\sources\models.dev-git | disabled | deployment-controlled | STARPORT_CACHE_DIR, STARPORT_CATALOG_ACQUISITION_SOURCES |
