Arguments - Manual - Apax Extension - Apax Extension provides UI and commands to execute the Apax CLI for SIMATIC AX - Apax Extension,extension, apax

Apax Extension

Portfolio
SIMATIC AX
Product
Apax Extension
Software version
1.1.0
Edition
11/2025
Language
English (original)
Package Name
@ax-vscode/siemens.apax-v3
type CommandArgsApax = {
    "apax-v3/apax/create": Partial<caCreate>
    "apax-v3/apax/yml/add": Partial<caAddPackages>
    "apax-v3/apax/yml/remove": Partial<caRemove>
    "apax-v3/apax/yml/install": Partial<caInstall>
    "apax-v3/apax/yml/clean": Partial<caApaxYml>
    "apax-v3/apax/yml/update": Partial<caUpdate>
    "apax-v3/apax/yml/update/all": Partial<caUpdateAll>
    "apax-v3/apax/yml/update-catalog": Partial<caUpdateCatalog>
    "apax-v3/apax/yml/run": Partial<caRun>
    "apax-v3/apax/region/set": Partial<caSetRegion>
    "apax-v3/apax/registry/login-ax": Partial<caLoginAx>
    "apax-v3/apax/registry/login-external": Partial<caLoginExternal>
    "apax-v3/apax/registry/ax/list/package": Partial<caRegistryAxListPackageInfo | caRegistryAxListPackageVersions>
    "apax-v3/apax/registry/ax/list/keyword": Partial<caRegistryAxListKeyword>
    "apax-v3/apax/search": Partial<caSearch>
    "apax-v3/apax/view": Partial<caView>
}

type caCreate = {
    directory: vscode.Uri
    project_name: string
    template_name: string
    template_version?: string
    create_directory?: boolean
}

type caAddPackages = {
    apax_yml: vscode.Uri
    packages: {
        name: string
        version?: string
    }[]
    section?: "dependencies" | "devDependencies" | "catalogs"
    version_range?: "caret" | "tilde" | "exact"
}

type caRemove = {
    apax_yml: vscode.Uri
    packages: {
        name: string
    }[]
}

type caInstall = {
    apax_yml: vscode.Uri
    catalog?: boolean
    local_copy?: boolean
    redownload?: boolean
}

type caApaxYml = {
    apax_yml: vscode.Uri
}

type caUpdate = {
    apax_yml: vscode.Uri
    packages: {
        name: string
        version?: string
    }[]
    force_latest?: boolean
}

type caUpdateAll = {
    apax_yml: vscode.Uri
    force_latest?: boolean
}

type caUpdateCatalog = {
    apax_yml: vscode.Uri
    packages: {
        name: string
        version?: string
    }[]
    force_latest?: boolean
}

type caRun = {
    apax_yml: vscode.Uri
    script_name: string
    script_args?: string[]
}

type caLoginAx = {
    token: string
}

type caLoginExternal = {
    registry_url: string
    username?: string
    password: string
}

type caRegistryAxListPackageInfo = {
    package_name: string
    package_version?: string
}

type caRegistryAxListPackageVersions = {
    package_name: string
}

type caRegistryAxListKeyword = {
    keyword: string
}

type caSetRegion = {
    region_id: string
}

type caSearch = {
    search_terms: string[]
    search_options?: {
        scope?: string
        github_api_url?: string
        registry_type?: string
        registry_url?: string
    }
    apax_yml?: vscode.Uri
}

type caView = {
    package_name: string
    package_version?: string
    view_options?: {
        registry_type?: string
        registry_url?: string
    }
    apax_yml?: vscode.Uri
}