• Sign in

cMeta stable releases and API

[ Back ]
Search — cMeta documentation 0.32.1 documentation
cMeta documentation

cMeta v0.32.1 Contents:

  • cMeta Project Home
    • Core idea
    • What you get
    • Use cases
    • Quickstart
    • Documentation
    • Attribution and reuse
    • Project information
    • Links

Guides:

  • cMeta documentation
    • Guides
      • Suggested reading order
      • For AI agents extending cMeta
    • Building the API reference
      • Layout
  • Why cMeta
    • The problem
    • The aim
      • How: complexity becomes abstractions you can operate
      • Why this matters more with AI
    • The approach
    • Design principles
    • FAIR by construction
    • What people use it for
    • What it is not
    • Where this came from
    • Next
  • Installing cMeta
    • Requirements
      • Installing uv
    • Option 1 — uv tool (a global cx, recommended)
    • Option 2 — uv + a project virtual environment
    • Option 3 — pip + a project virtual environment
    • Latest from source
    • Choosing where repositories live
    • Serial or async — choosing extras
    • Verify the installation
    • Python interface
    • Optional configuration
    • Working with artifact repositories
    • Troubleshooting
  • Common commands and tips
    • Discovery — finding your way around
    • cx . — work from the current directory
      • cx . info — the “where am I?” command
    • Artifacts
      • Searching across categories
    • UIDs
    • Repositories
    • Configuration
    • Index and cache
    • Output, scripting and debugging
    • Flag syntax
    • Handy one-liners
  • Using cMeta
    • 1. Mental model in 60 seconds
    • 2. First checks after install
    • 3. Common CLI flags
      • 3.1 Global flags
      • 3.2 Command dispatch flags
      • 3.3 Output / debug flags (apply to any command)
      • 3.4 Framework initialisation flags
      • 3.5 Flag syntax rules
      • 3.6 A few useful combinations
    • 4. Built-in categories (plugins)
    • 5. Working with artifacts
      • 5.1 Find and inspect
      • 5.2 Create, update, tag, delete
      • 5.3 From Python
      • 5.4 ctx — thread state (and AI-agent context) through nested calls
      • 5.5 Working from the current directory (cx .)
      • 5.6 Generating UIDs (and other utils helpers)
      • 5.7 Searching across categories (cx utils find_by_cid)
    • 6. Resolving categories & artifacts (alias / UID / alias,UID)
    • 7. cMeta repositories
      • 7.1 What a cMeta repo is
      • 7.2 The three tiers you always have
      • 7.3 Where things live under <CMETA_HOME>
      • 7.4 Picking <CMETA_HOME> (env vars + per-project collections)
      • 7.5 Registered repos on disk
      • 7.6 _cmr.yaml — the repo descriptor
      • 7.7 Getting a repo (pull existing)
      • 7.8 Creating a new local repo
      • 7.9 Attaching / detaching an existing directory
      • 7.10 Everyday repo commands
      • 7.11 Programmatic use
    • 8. Configuring categories via config artifacts
      • 8.1 The config category — five commands
      • 8.2 Everyday examples
      • 8.3 The pattern from Python — reading a config from any category
      • 8.4 Configuring a shipped app (the app convention)
      • 8.5 The cserver (FastAPI) example — configs consumed by async server code
      • 8.6 Where config artifacts live on disk
    • 9. Adding a new category (plugin)
      • 9.1 Editing api/v1.py
      • 9.2 Prefer self.cm.utils.* over stdlib re-implementations
      • 9.3 Calling other categories from your plugin
    • 10. Adding artifacts of a category
    • 11. Fast index & when to cx --reindex
    • 12. Scaling a category to very many artifacts
      • 12.1 Sharding — sharding_slices
      • 12.2 Skipping the index — no_index
      • 12.3 Combining them
    • 13. Where to look next
  • Error handling
    • 1. The return contract
      • Why a dict instead of exceptions
    • 2. Checking a result
      • The recommended form
      • The simplified form
      • From a plain script (no plugin context)
    • 3. Soft errors — return code 16
      • Escalating a soft error
      • One deliberate exception
    • 4. Raising errors
      • From a plugin (api/v1.py)
      • From low-level code with no CMeta instance
      • When to raise instead
    • 5. Handling errors from the CLI (scripts, CI, agents)
      • Machine-readable output
      • Linux / macOS (bash)
      • Windows (batch / cmd.exe)
      • Windows (PowerShell)
    • 6. Debugging — making cMeta raise
      • Ways to turn it on
      • Related debug flags
    • 7. Debugging in an IDE
      • Visual Studio Code
      • Visual Studio
      • PyCharm
      • Reading the traceback
    • 8. Quick reference
  • Async and concurrency
    • 1. Two ways to run
    • 2. Serial use
    • 3. Async use (CMetaAsync)
      • Errors cross the process boundary unchanged
      • Running calls in parallel
      • access_sync() — know the limitation
      • Who uses this
      • FastAPI
    • 4. Concurrency safety guards
      • Locking + atomic writes
      • Measured behaviour
      • What is not concurrency-safe
      • Practical notes
    • 5. Choosing a mode
  • Working with configs
    • Commands
    • Examples
    • Keep secrets private
    • See also
  • Connecting to the cTuning.ai platform
    • Prerequisites
    • Configure access
    • Test the connection
    • Keep your API token private
    • See also
  • History and background
    • Lineage
    • Related publications and talks
    • How to cite
      • Reusing the code or the concepts
    • License note
  • Known issues and planned improvements
    • KI-001
    • KI-002
    • KI-003
    • Adding an entry

API Reference:

  • API Reference (v0.32.1)
    • cmeta.category module
      • Classes
        • InitCategory
    • cmeta.category_api_v1 module
      • Classes
        • Category
    • cmeta.cli module
      • Functions
        • catch()
        • main()
        • main_cmeta()
        • main_cserver()
        • main_cx()
        • main_cxt()
        • main_meta()
        • main_ucmeta()
        • main_ucx()
        • main_ucxt()
        • main_umeta()
        • process()
        • set_fail_on_error()
      • Constants
        • cli_init_params_desc
        • cli_params_desc
        • fail_on_error
        • params_command2_desc
    • cmeta.config module
      • Functions
        • check_init_vars_from_env()
        • is_on()
        • set_logging()
        • update_init_and_setup_logger()
      • Constants
        • cfg
        • log_level_mapping
        • params_command2_desc
        • params_command3_desc
        • params_command_desc
        • params_desc
        • params_init_desc
    • cmeta.core module
      • Classes
        • CMeta
      • Constants
        • control_params_desc
    • cmeta.core_async module
      • Classes
        • CMetaAsync
    • cmeta.packages module
      • Classes
        • PackageResult
        • Packages
    • cmeta.repos module
      • Classes
        • Repos
    • cmeta.utils.cli module
      • Functions
        • check_params()
        • parse_cmd()
        • print_params_help()
        • split_flag()
    • cmeta.utils.common module
      • Functions
        • build_sort_key()
        • check_params()
        • compare_versions()
        • copy_text_to_clipboard()
        • deep_merge()
        • deep_remove()
        • detect_cid_in_the_current_directory()
        • expand_string()
        • expand_strings_in_dict()
        • expand_strings_in_list()
        • first_digit_pos()
        • flatten_dict()
        • generate_timestamp()
        • matches_query()
        • normalize_tags()
        • print_module_vars()
        • restricted_bool_eval()
        • safe_print_json()
        • safe_print_json_to_str()
        • safe_print_json_with_enter()
        • safe_serialize_json()
        • smart_get()
        • smart_merge()
        • smart_set()
        • sort_versions()
        • split()
        • split_clean()
        • value_matches()
    • cmeta.utils.files module
      • Functions
        • apply_sharding_to_path()
        • ask_to_delete()
        • cpath()
        • diff_env()
        • files_decode()
        • files_encode()
        • gen_temp_filepath()
        • get_creation_time()
        • get_latest_modification_time()
        • get_latest_tree_modification_time()
        • is_dir_empty()
        • is_dir_within_path()
        • is_path_within()
        • load_files()
        • lock_path()
        • md5sum()
        • parse_env_dump()
        • quote_path()
        • quote_path2()
        • read_file()
        • remove_dirs_from_path()
        • remove_files_and_dirs_in_path()
        • safe_delete_directory()
        • safe_delete_directory_if_empty()
        • safe_delete_directory_if_empty_with_sharding()
        • safe_json_dumps()
        • safe_read_file()
        • safe_read_file_via_cache()
        • safe_read_yaml_or_json()
        • safe_write_file()
        • shard_name()
        • unlock_path()
        • unzip()
        • write_file()
        • zip_directory()
      • Constants
        • ERROR_CODE_FILE_NOT_FOUND
        • LOCK_SUFFIX
        • RETRY_DELAY
        • RETRY_DELETE_ATTEMPTS
        • RETRY_NOT_FOUND_FILE
        • RETRY_NOT_FOUND_INDEX_FILE
        • RETRY_REPLACE_FILE
        • RETRY_TIMESTAMP_FILE
    • cmeta.utils.names module
      • Functions
        • generate_cmeta_uid()
        • get_sort_key_cmeta_obj_alias_or_uid()
        • is_valid_category_alias()
        • is_valid_cmeta_alias()
        • is_valid_cmeta_uid()
        • parse_cmeta_name()
        • parse_cmeta_obj()
        • parse_cmeta_ref()
        • parse_cmeta_ref_with_path()
        • restore_cmeta_name()
        • restore_cmeta_obj()
        • restore_cmeta_ref()
    • cmeta.utils.net module
      • Functions
        • access_api()
        • download()
        • unify_request()
    • cmeta.utils.sys module
      • Functions
        • find_command_func()
        • find_func_definition()
        • flush_input()
        • format_size()
        • get_api_info()
        • get_api_text()
        • get_dir_size()
        • get_disk_space()
        • get_func_properties()
        • get_min_arch_host_info()
        • get_min_host_info()
        • get_min_raw_host_info()
        • load_module()
        • plus_env()
        • run()
        • run_command_with_timeout_tree_kill_on_windows()
    • cmeta.version module
      • Module Contents
cMeta documentation
  • Search

© Copyright 2025-2026, Grigori Fursin and cTuning Labs.

Terms  |  Privacy  |  About  |  Contact us
Powered by cMeta and cMeta AOps