### ubc quickstart

Source: https://ubcode.useblocks.com/usage/ubc_ci_cd.html

Creates an example ubcode project at the specified path.

```APIDOC
## ubc quickstart

### Description
Create an example ubcode project.

### Arguments
- **path** (PATH) - Optional - The path to write to (defaults to the current directory)

### Options
- **-o, --overwrite** (BOOL) - Optional - Overwrite existing files
- **-f, --flavor** (CHOICE) - Optional - The project flavor to scaffold (minimal, full, markdown, variants). Default: minimal.
```

--------------------------------

### Complete preprocessor configuration example

Source: https://ubcode.useblocks.com/configuration/codelinks.html

A comprehensive example combining source discovery and preprocessor settings.

```toml
[codelinks.projects.my_app.source_discover]
src_dir = "../src"
include = ["**/*.cpp", "**/*.h"]
comment_type = "cpp"

[codelinks.projects.my_app.analyse.preprocessor]
compile_commands = "../build/compile_commands.json"
defines = ["FEATURE_X=1", "NDEBUG"]
includes = ["../include"]
std = "c++17"
```

--------------------------------

### Enable syntax example numbering

Source: https://ubcode.useblocks.com/configuration/parsing.html

Configures the project to automatically number syntax example blocks.

```toml
[parse]
extensions = ["sphinx_syntax_example"]
syntax_example_numbering = true
```

--------------------------------

### Real-world scenario examples

Source: https://ubcode.useblocks.com/usage/ubquery.html

Practical examples for common requirement management tasks.

```text
# High priority open requirements
type == 'requirement' and status == 'open' and priority >= 8

# Security-related items needing attention
('security' in title.lower() or 'CVE' in description) and status != 'closed'

# Requirements ready for review
type == 'requirement' and status == 'draft' and len(description) >= 100 and assignee is not None
```

--------------------------------

### Example build warning message

Source: https://ubcode.useblocks.com/configuration/linting.html

An example of a build warning message format including the docname prefix.

```text
[build.video_glob_unsupported]
  guide/intro: a video source cannot be a wildcard pattern ...
```

--------------------------------

### Cross-reference role syntax examples

Source: https://ubcode.useblocks.com/authoring/roles.html

Examples of using ref and need roles, including custom link text and opting out of link hydration.

```rst
See :ref:`installation` for setup.
:ref:`Custom link text <installation>`
:ref:`!installation`
:need:`REQ_001`
:need:`REQ_001.part_a`
```

--------------------------------

### Preview Installation Plan

Source: https://ubcode.useblocks.com/usage/agentic_engineer/quickstart.html

Generates a JSON proposal of the detected workflow without modifying project configuration files.

```bash
ubc agent install --detect --plan
```

--------------------------------

### Minimal HTML Build Configuration

Source: https://ubcode.useblocks.com/configuration/build_html.html

A basic example showing how to set the site title, logo, and extra CSS files in the configuration file.

```toml
[build.html]
title = "My Project Docs"
logo = "_static/logo.svg"
extra_css = ["_static/theme.css"]
```

--------------------------------

### Minimal ubproject.toml configuration

Source: https://ubcode.useblocks.com/configuration/project_and_source.html

A basic configuration example defining project name, source directory, exclusion patterns, and a build script.

```toml
[project]
name = "My Docs"
srcdir = "docs"         # root directory for source files

[source]
extend_exclude = ["_build/**"]

[scripts]
build = "sphinx-build -b html docs docs/_build/html"
```

--------------------------------

### Directory structure for configuration redirection

Source: https://ubcode.useblocks.com/configuration/index.html

Example layout showing how a redirect file in a source directory points to a configuration file in the documentation directory.

```text
project/
├── docs/
│   ├── doc1.rst
│   └── ubproject.toml
└── src/
    ├── main.py
    └── ubproject.redirect.toml   # contains: path = "../docs"
```

--------------------------------

### Complete Codelinks Configuration

Source: https://ubcode.useblocks.com/configuration/codelinks.html

A full configuration file example demonstrating schema definition, need types, and project-specific codelinks settings.

```toml
"$schema" = "https://ubcode.useblocks.com/ubproject.schema.json"

[needs]
id_required = true

[[needs.types]]
directive = "impl"
title = "Implementation"
prefix = "IMPL_"

[[needs.types]]
directive = "req"
title = "Requirement"
prefix = "REQ_"

[needs.fields.source_file]
description = "Source file for codelinks needs"

[needs.links.implements]
incoming = "implemented by"
outgoing = "implements"

# --- Codelinks configuration ---

[codelinks]
set_remote_url = true
remote_url_field = "remote-url"

[codelinks.projects.my_app]
remote_url_pattern = "https://github.com/org/repo/blob/{commit}/{path}#L{line}"

[codelinks.projects.my_app.source_discover]
src_dir = "../src"
include = ["**/*.cpp", "**/*.h"]
gitignore = true
comment_type = "cpp"

[codelinks.projects.my_app.analyse]
get_oneline_needs = true
get_need_id_refs = true
get_rst = false

[codelinks.projects.my_app.analyse.oneline_comment_style]
start_sequence = "@"
field_split_char = ","
needs_fields = [
    { name = "title", type = "str" },
    { name = "id", type = "str" },
    { name = "type", type = "str", default = "impl" },
    { name = "implements", type = "list[str]", default = [] },
]

[codelinks.projects.my_app.analyse.need_id_refs]
markers = ["@need-ids:"]

[codelinks.projects.my_app.analyse.marked_rst]
start_sequence = "@rst"
end_sequence = "@endrst"

# Optional: use the preprocessor-aware libclang engine for the C/C++ files,
# so that markers in inactive #if / #ifdef branches are excluded.
[codelinks.projects.my_app.analyse.preprocessor]
compile_commands = "../build/compile_commands.json"
defines = ["FEATURE_X=1"]
includes = ["../include"]
std = "c++17"
```

--------------------------------

### One-line Need Marker Example

Source: https://ubcode.useblocks.com/configuration/codelinks.html

Example of a compact one-line marker format within a source code comment.

```text
// @Function Bar, IMPL_4, impl, [SPEC_1]
```

--------------------------------

### Common ubc CLI Commands

Source: https://ubcode.useblocks.com/usage/ubc_ci_cd.html

Examples of standard operations including linting, formatting, building, and diffing project files.

```bash
# Lint all files in the current directory
ubc check .

# Format files, failing if any would change (CI mode)
ubc format --check .

# Build the needs index as JSON
ubc build needs . -f json -o needs.json

# Show resolved configuration
ubc config . --indent 2

# Diff needs between two git refs
ubc diff git main feature-branch
```

--------------------------------

### Specify Extensions as a List

Source: https://ubcode.useblocks.com/configuration/parsing.html

Example of enabling extensions using a simple list of names.

```toml
[parse.parsers.md]
extensions = ["deflist", "dollarmath"]
```

--------------------------------

### Configure Extensions with Options

Source: https://ubcode.useblocks.com/configuration/parsing.html

Example of enabling, disabling, and configuring specific Markdown extensions using a table.

```toml
[parse.parsers.md]
flavour = "gfm"

[parse.parsers.md.extensions]
deflist = true                               # enable on top of the flavour
tasklist = false                             # disable a GFM default
dollarmath = { allow_space = true, allow_digits = false }
strikethrough = { single_tilde = true }
colon_fence = { exact_match = true }
```

--------------------------------

### Configure Parser Routing

Source: https://ubcode.useblocks.com/configuration/parsing.html

Example configuration showing how to define multiple parsers with specific include globs.

```toml
[parse.parsers.rst]

[parse.parsers.md]
include = ["*.md"]

[parse.parsers.design]
type = "md"
flavour = "myst"
include = ["docs/design/**/*.md"]
```

--------------------------------

### Example build output

Source: https://ubcode.useblocks.com/usage/build_html.html

The console output displayed after successfully running the build command, indicating the number of files processed and the location of the generated site.

```text
Building index for: /home/me/project/ubproject.toml
Processing 3 files
3 page(s): 3 rendered, 0 reused; 3 written, 0 unchanged; 5 asset(s).
Site written to: /home/me/project/_build/html
Root page: /home/me/project/_build/html/index.html
Done in 0.12s
```

--------------------------------

### Basic documentation project configuration

Source: https://ubcode.useblocks.com/configuration/index.html

A minimal configuration setup for simple documentation projects requiring specific ID formats.

```toml
"$schema" = "https://ubcode.useblocks.com/ubproject.schema.json"

[project]
name = "My Documentation"
version = "1.0.0"
description = "User documentation for our product"

[needs]
id_required = true
id_regex = "^[A-Z]{3}_[0-9]{3}$"  # Format: ABC_123

[[needs.types]]
directive = "requirement"
title = "Requirement"
prefix = "REQ_"
color = "#BFD8D2"
```

--------------------------------

### Minimal Needs Configuration

Source: https://ubcode.useblocks.com/configuration/needs.html

A basic setup defining ID requirements, regex validation, custom types, and link relationships.

```toml
[needs]
id_required = true
id_regex = "^[A-Z]{3}_[0-9]{3}$"

[[needs.types]]
directive = "requirement"
title = "Requirement"
prefix = "REQ_"

[needs.links.implements]
outgoing = "implements"
incoming = "implemented by"

[needs.fields.priority]
description = "Priority level"
```

--------------------------------

### Minimal Linting Configuration

Source: https://ubcode.useblocks.com/configuration/linting.html

A basic setup demonstrating global ignore rules and per-file specific overrides.

```toml
[lint]
ignore = ["block.title_line"]

[lint.per-file-ignores]
"tests/**/*.rst" = ["needs.dead_link"]
```

--------------------------------

### Directory structure for hierarchical configuration

Source: https://ubcode.useblocks.com/configuration/index.html

Example directory layout demonstrating how ubproject.toml files are resolved based on proximity to source files.

```text
project/
├── docs1/
│   ├── doc1.rst
│   └── ubproject.toml
├── docs2/
│   └── doc2.rst
└── ubproject.toml
```

--------------------------------

### Directive options syntax

Source: https://ubcode.useblocks.com/configuration/parsing.html

Example of a directive using a field list for options.

```rst
.. my-directive::
   :option1: value1
   :option2: value2

   Content here.
```

--------------------------------

### List operation examples

Source: https://ubcode.useblocks.com/usage/ubquery.html

Filtering based on list membership and exclusion.

```text
# Check if status is one of several values
status in ['open', 'in_progress', 'review']

# Check if tags contain a specific tag
'critical' in tags

# Exclude items with certain tags
'deprecated' not in tags
```

--------------------------------

### Complex condition examples

Source: https://ubcode.useblocks.com/usage/ubquery.html

Combining multiple logical conditions and grouping.

```text
# Multiple conditions with AND
type == 'requirement' and status == 'open' and priority >= 7

# Multiple conditions with OR
priority >= 8 or 'critical' in tags or 'security' in description.lower()

# Grouping with parentheses
(status == 'open' or status == 'in_progress') and assignee != None
```

--------------------------------

### Project metadata configuration

Source: https://ubcode.useblocks.com/configuration/project_and_source.html

Example of defining core project metadata including name, version, description, root document, and source directory.

```toml
[project]
name = "My Project"
version = "1.0.0"
description = "My project description"
root_doc = "index"
srcdir = "src"
```

--------------------------------

### Basic filtering examples

Source: https://ubcode.useblocks.com/usage/ubquery.html

Common patterns for filtering by status, priority, and existence.

```text
# Filter by status
status == 'open'

# Filter by priority with number comparison
priority > 5

# Check if title is not empty
title
```

--------------------------------

### Length and null check examples

Source: https://ubcode.useblocks.com/usage/ubquery.html

Validating attribute presence and content length.

```text
# Check for non-empty descriptions
description is not None and len(description) > 50

# Filter items with tags
len(tags) > 0

# Unassigned items
assignee is None
```

--------------------------------

### String operation examples

Source: https://ubcode.useblocks.com/usage/ubquery.html

Filtering based on string manipulation and prefix matching.

```text
# Case-insensitive search
type.lower() == 'requirement'

# Check if description contains specific text
'security' in description.lower()

# Title starts with specific prefix
title.startswith('REQ-')
```

--------------------------------

### Install and Detect Workflow

Source: https://ubcode.useblocks.com/usage/agentic_engineer/quickstart.html

Derives a drivable workflow from an existing Sphinx-Needs graph by analyzing links and schema.

```bash
ubc agent install --detect
```

--------------------------------

### View unhandled role reports

Source: https://ubcode.useblocks.com/configuration/build_html.html

Example output showing how unhandled or unrecognized roles are reported during the build process.

```text
[build.role_unhandled] mailheader: 3 sites rendered as chips
  — unhandled or unrecognised role (first guide:4, index:4, index:6)
[build.role_unhandled] envvar: 1 site rendered as a chip
  — unhandled or unrecognised role (at guide:4)
```

--------------------------------

### View build status output

Source: https://ubcode.useblocks.com/usage/build_html.html

Example of the console output reporting the status of rendered, reused, written, and unchanged pages during a build.

```text
3 page(s): 0 rendered, 3 reused; 0 written, 3 unchanged; 5 asset(s).
```

--------------------------------

### Configure Quality Analysis

Source: https://ubcode.useblocks.com/configuration/quality.html

Example of wiring reviewed types to criteria packs and setting per-axis floors for the substance gate.

```toml
[quality]
enabled = true

[quality.type_configs.req]
criteria_file = "quality/requirement.toml"

[quality.type_configs.arch]
criteria_file = "quality/arch.toml"

[quality.type_configs.user_story]
criteria_file = "quality/feat.toml"

[quality.type_configs.decision]
criteria_file = "quality/decision.toml"

# Per-axis floors (the gate). A need passes only when every floored axis meets its
# floor; pass/fail is computed at read time, so retuning re-judges existing verdicts.
[quality.required]
parent_fit = 1

# A per-type floor override, merged over the global map (per-type wins per axis).
[quality.type_configs.decision.required]
context_present = 1
```

--------------------------------

### Minimal Codelinks Configuration

Source: https://ubcode.useblocks.com/configuration/codelinks.html

Basic setup for scanning a source directory and generating remote GitHub URLs for needs.

```toml
[codelinks]
set_remote_url = true

[codelinks.projects.my_app]
remote_url_pattern = "https://github.com/org/repo/blob/{commit}/{path}#L{line}"

[codelinks.projects.my_app.source_discover]
src_dir = "../src"
comment_type = "python"

[codelinks.projects.my_app.analyse]
get_oneline_needs = true
```

--------------------------------

### Match Needs by Type and Field

Source: https://ubcode.useblocks.com/usage/ubquery.html

Examples of filtering needs using labels and property predicates.

```cypher
MATCH (n:requirement) WHERE n.status = 'open' RETURN n
```

```cypher
MATCH (n:requirement {status: 'open'}) RETURN n
```

--------------------------------

### Querying Backlink Fields

Source: https://ubcode.useblocks.com/usage/ubquery.html

Examples of filtering based on incoming link relationships in view directives.

```text
not implements_back        # nothing implements this need
len(blocks_back) > 1       # more than one need blocks this one
"REQ_1" in links_back      # REQ_1 links to this need
```

--------------------------------

### Boolean Truthiness Examples

Source: https://ubcode.useblocks.com/usage/ubquery.html

Demonstrates how attributes are evaluated in a boolean context based on their content or type.

```text
title                    # True if title is not empty, False, 0, or None
not title                # True if title is empty, False, 0, or None
tags                     # True if tags list has items
not tags                 # True if tags list is empty
```

--------------------------------

### Configure linting silence rules

Source: https://ubcode.useblocks.com/configuration/build_html.html

Configuration examples for ignoring specific build codes or narrowing ignores to specific messages.

```toml
[lint]
ignore = ["build.directive_unhandled", "build.role_unhandled"]
```

```toml
[[lint.message-ignores]]
codes = ["build.directive_unhandled"]
contains = "acks:"
```

--------------------------------

### Filter needs by title

Source: https://ubcode.useblocks.com/usage/ubquery.html

Performs a case-insensitive search for needs where the title starts with a specific string.

```cypher
MATCH (n) WHERE toLower(n.title) STARTS WITH "my string" RETURN n
```

--------------------------------

### Filter Needs by Relationships

Source: https://ubcode.useblocks.com/usage/ubquery.html

Examples of traversing the graph to filter needs based on link types and chain depth.

```cypher
// needs that link to any requirement through a `links` relationship
MATCH (n)-[:links]->(:requirement) RETURN n

// requirements that are satisfied by at least one other need
MATCH (n:requirement)<-[:satisfies]-() RETURN n
```

```cypher
// requirements with no incoming `satisfies` link
MATCH (n:requirement) WHERE NOT EXISTS { (n)<-[:satisfies]-() } RETURN n

// needs reachable from a spec through 1 to 3 `links` hops
MATCH (n)-[:links*1..3]->(:spec) RETURN n
```

```cypher
// requirements whose satisfying spec is itself implemented
// (a trace across two different link types)
MATCH (n:requirement)<-[:satisfies]-(:spec)<-[:links]-() RETURN n
```

--------------------------------

### Marked RST Block Example

Source: https://ubcode.useblocks.com/configuration/codelinks.html

Example of embedding reStructuredText within a source code comment.

```text
// @rst
// .. req:: My Requirement
//    :id: REQ_INLINE
//
//    This requirement lives in source code.
// @endrst
```

--------------------------------

### Configure syntax-example extension

Source: https://ubcode.useblocks.com/authoring/directives.html

Add the sphinx_syntax_example module to the parsing configuration to enable the directive.

```toml
[parse]
extensions = ["sphinx_syntax_example"]
```

--------------------------------

### Need-ID Reference Marker Example

Source: https://ubcode.useblocks.com/configuration/codelinks.html

Example of a marker used to link a code location to existing needs.

```text
// @need-ids: REQ_001, REQ_002
```

--------------------------------

### Transition Line Example

Source: https://ubcode.useblocks.com/configuration/formatting.html

Visual representation of a transition line.

```rst
--------  # 8 character transition with "-"
```

--------------------------------

### Scaffold a new project

Source: https://ubcode.useblocks.com/basics/quickstart.html

Initialize a project structure in the current directory or a new folder using the command line.

```bash
ubc quickstart             # scaffold into the current directory
ubc quickstart my-project  # scaffold into a new directory
```

--------------------------------

### Semantic Paragraph Wrapping

Source: https://ubcode.useblocks.com/configuration/formatting.html

Example of semantic wrapping behavior.

```rst
# With semantic wrapping:
This is a sentence.
This is another sentence with a clause,
and here's the rest.
```

--------------------------------

### Directive argument syntax

Source: https://ubcode.useblocks.com/configuration/parsing.html

Example of a directive using an argument on the same line.

```rst
.. my-directive:: This is the argument

   Content here.
```

--------------------------------

### Directive Indentation Example

Source: https://ubcode.useblocks.com/configuration/formatting.html

Visual representation of directive content indentation.

```rst
.. note::
   This content is indented 3 spaces.
```

--------------------------------

### Use syntax-example directive

Source: https://ubcode.useblocks.com/authoring/directives.html

Displays raw markup source and its rendered result. The content can include nested directives like note.

```rst
.. syntax-example:: A note

   Use a ``note`` admonition for **supplementary** information.

   .. note::

      This box is rendered from the source shown above.
```

--------------------------------

### Run the HTML build command

Source: https://ubcode.useblocks.com/usage/build_html.html

Execute the build command from within the project directory to generate the static site.

```bash
ubc build html
```

--------------------------------

### Blockquote Indentation Example

Source: https://ubcode.useblocks.com/configuration/formatting.html

Visual representation of blockquote indentation settings.

```rst
This is a paragraph.

  This is a blockquote, indented 2 spaces.
```

--------------------------------

### Define Basic and Advanced Scripts

Source: https://ubcode.useblocks.com/configuration/project_and_source.html

Demonstrates simple command definition versus object-based configuration with environment variables and Jinja templating.

```toml
[scripts]
sphinx1 = "sphinx-build -b html . _build/html {{filepath}}"
sphinx2 = { cmd = "sphinx-build -b html . _build/html {{filepath}}", env = { SPHINXOPTS = "-W" }, terminal = "name", jinja = true }
```

--------------------------------

### GitHub-style Alert Syntax

Source: https://ubcode.useblocks.com/configuration/parsing.html

Example of the alert syntax used within blockquotes.

```markdown
> [!NOTE]
> Highlights information that users should take into account.
```

--------------------------------

### One-line Marker Transformation

Source: https://ubcode.useblocks.com/configuration/codelinks.html

Example of a one-line marker and its equivalent need representation.

```text
// @Function Bar, IMPL_4, impl, [SPEC_1, SPEC_2]
```

```text
.. impl:: Function Bar
   :id: IMPL_4
   :links: SPEC_1, SPEC_2
```

--------------------------------

### Substitution Indentation Example

Source: https://ubcode.useblocks.com/configuration/formatting.html

Visual representation of substitution definition content indentation.

```rst
.. |name| replace::
   Substitution content indented 3 spaces.
```

--------------------------------

### Comparing documentation states

Source: https://ubcode.useblocks.com/features/diff/index.html

Compare needs.json files from different builds and generate a light-themed HTML comparison report.

```bash
# Compare exported needs.json files from different builds
ubc diff --needs old-build/needs.json --needs new-build/needs.json \
  --impact \
  --format html --html-theme light --outpath comparison.html
```

--------------------------------

### Literal Block Indentation Example

Source: https://ubcode.useblocks.com/configuration/formatting.html

Visual representation of literal block indentation.

```rst
This is a paragraph::

  This literal block is indented 2 spaces.
```

--------------------------------

### Bootstrap a project with ubc agent

Source: https://ubcode.useblocks.com/usage/agentic_engineer/quickstart.html

Initializes a project using a specific profile and optionally registers the MCP server for terminal-based AI agents.

```bash
ubc agent install                 # scaffold the default `vmodel` profile
ubc agent install --profile vmodel

# Opt-in: also register the ubCode MCP server with a terminal harness's own
# CLI, so an agent running in your terminal gets the ubCode tools.
ubc agent install --register-mcp claude-code-cli
```

--------------------------------

### Field List Indentation Example

Source: https://ubcode.useblocks.com/configuration/formatting.html

Visual representation of field list body indentation.

```rst
:Author: John Doe
  Second line indented 2 spaces.
```

--------------------------------

### Configure source code redirection

Source: https://ubcode.useblocks.com/usage/codelinks.html

Place this file in the source directory to redirect ubCode to the documentation configuration.

```toml
# src/ubproject.redirect.toml
path = "../docs"

```

--------------------------------

### Definition List Indentation Example

Source: https://ubcode.useblocks.com/configuration/formatting.html

Visual representation of definition list body indentation.

```rst
Term
  Definition body indented 2 spaces.
```

--------------------------------

### Configure todo extension

Source: https://ubcode.useblocks.com/authoring/directives.html

Enable the todo and todolist directives by adding the sphinx.ext.todo extension to the configuration.

```toml
[parse]
extensions = ["sphinx.ext.todo"]
```

--------------------------------

### Define Variant Data

Source: https://ubcode.useblocks.com/usage/variants.html

Example of declaring variant parameters and build tags for use in filtering.

```toml
build_tags = ["html"]

[needs.variant_data]
platform = "arm"
archs = ["arm", "x86"]

[needs.variant_data.build]
compiler = "clang"
features = ["networking", "logging"]
```

--------------------------------

### Configure ubcode.toml file path

Source: https://ubcode.useblocks.com/usage/ublicense.html

The location of the configuration file varies by operating system.

```text
~/.config/ubcode/ubcode.toml
```

```text
C:\Users\<username>\AppData\Local\useblocks\ubcode\ubcode.toml
```

```text
~/Library/Application Support/ubcode/ubcode.toml
```

--------------------------------

### Configure Marked RST Delimiters

Source: https://ubcode.useblocks.com/configuration/codelinks.html

Sets the start and end sequences for marked RST blocks.

```toml
[codelinks.projects.my_app.analyse.marked_rst]
start_sequence = "@rst"
end_sequence = "@endrst"
```

--------------------------------

### Minimal Server Configuration

Source: https://ubcode.useblocks.com/configuration/server.html

A basic configuration block for enabling core language server features.

```toml
[server]
hover_images = true
hover_need_refs = true
code_lenses = true
index_on_save = true
index_debounce_ms = 500
```

--------------------------------

### Configure a project with ubproject.toml

Source: https://ubcode.useblocks.com/basics/key_concepts.html

Define project needs and types using the TOML format for fast, declarative configuration.

```toml
"$schema" = "https://ubcode.useblocks.com/ubproject.schema.json"

[[needs.types]]
directive = "req"
title = "Requirement"
prefix = "REQ_"
```

--------------------------------

### Scaffold a project with a specific flavor

Source: https://ubcode.useblocks.com/basics/quickstart.html

Use the --flavor flag to initialize a project with a predefined template, such as the full feature tour.

```bash
ubc quickstart my-project --flavor full
```

--------------------------------

### Configure proxy settings

Source: https://ubcode.useblocks.com/usage/ublicense.html

Define an HTTP CONNECT proxy server if system-level detection fails.

```toml
[proxy]
https = "<proxy-domain-or-ip>"
```

--------------------------------

### Compare projects

Source: https://ubcode.useblocks.com/features/diff/index.html

Compares two project paths where the first argument is the baseline.

```bash
ubc diff --project old_path --project new_path  # first is baseline (old), second is new
```

--------------------------------

### Define named options for a directive

Source: https://ubcode.useblocks.com/configuration/parsing.html

Example of defining named options for a custom directive in the configuration file.

```toml
[parse.extend_directives.my-directive.named_options]
title = { description = "The title of the element" }
class = { description = "CSS classes to apply" }
```

--------------------------------

### Enable libclang preprocessor engine

Source: https://ubcode.useblocks.com/configuration/codelinks.html

Include an empty table to switch from the default tree-sitter parser to the libclang engine.

```toml
[codelinks.projects.my_app.analyse.preprocessor]
# An empty table is enough — its presence selects the libclang engine.
```

--------------------------------

### Select open needs using Cypher

Source: https://ubcode.useblocks.com/usage/ubquery.html

Demonstrates both the bare-expression shorthand and the full query syntax for selecting needs with an 'open' status.

```cypher
n.status = 'open'
MATCH (n) WHERE n.status = 'open' RETURN n
```