Skip to content

Add Cortex Code quickstart; fix stale --task-name/--env examples - #8

Merged
sfc-gh-daxu merged 1 commit into
Snowflake-Labs:masterfrom
sfc-gh-dhuang:docs/cortex-code-quickstart
Aug 28, 2026
Merged

Add Cortex Code quickstart; fix stale --task-name/--env examples#8
sfc-gh-daxu merged 1 commit into
Snowflake-Labs:masterfrom
sfc-gh-dhuang:docs/cortex-code-quickstart

Conversation

@sfc-gh-dhuang

Copy link
Copy Markdown
Contributor

Summary

  • Adds docs/cortex-code.md: setup notes specific to running the
    cortex-code agent (it needs its own Snowflake credentials for model
    access even on the hermetic DuckDB variant, disallowed_tools/cli_mode
    support for it only exists on Harbor main and not the latest release yet,
    and how to run one task without Harbor at all — by hand, or with Cortex
    Code driven directly inside a task container).
  • Fixes two examples in the README's "Running (DuckDB, no account)" section
    that don't work on current Harbor: --task-name no longer exists (renamed
    to -i/--include-task-name), and --env DB_TYPE=duckdb doesn't set an
    environment variable (--env/-e selects the environment type — use the
    shipped --config, which already sets environment.env). Also bumped the
    "tested with 0.20.x" note, since --task-name doesn't exist anywhere in
    the current harbor-framework/harbor source.
  • Links the new doc from the README (Links list, and next to the
    codex/cortex-code config mention).

Why a separate doc instead of folding into the README

The README's existing Getting Started / DuckDB / Snowflake sections are
already agent-agnostic and cover common setup for all three bundled agents.
Cortex Code needed enough extra, agent-specific detail (its own credential
requirement, the current disallowed-tools/cli_mode gap, running it without
Harbor) that inlining all of it would have meant either duplicating the
common setup steps or bloating the README with content most non-Cortex-Code
users don't need. The new doc cross-links back to the relevant README
sections instead of repeating them.

Test plan

  • Confirm -i/--include-task-name and --config (vs --task-name/
    --env DB_TYPE=...) against your own Harbor install, since I verified
    this by reading harbor-framework/harbor's source/releases rather than
    running the CLI myself.
  • Skim docs/cortex-code.md for anything Cortex-Code-version-specific
    that's since changed (disallowed_tools/cli_mode merge status).

README's DuckDB examples still use --task-name and --env DB_TYPE=duckdb,
which don't work on Harbor >= 0.21.0 (--task-name was renamed to
-i/--include-task-name; --env only selects the environment type, not
variables — use --config instead). Fixes both in the one-task and
fast-30 examples.

Adds docs/cortex-code.md covering what's specific to running the
cortex-code agent: it needs its own Snowflake credentials for model
access even on the hermetic DuckDB variant, disallowed_tools/cli_mode
support landed after the latest Harbor release, and how to run a task
without Harbor at all (by hand, or with Cortex Code driven directly
inside the task container).

@snowflake-security-bot snowflake-security-bot Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Snowflake Security Review

Security grade: A — Passed

This PR was classified as LOW risk by the automated pre-screen.

@snowflake-security-bot snowflake-security-bot Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Snowflake Security Review

Security grade: A — Passed

This PR was classified as LOW risk by the automated pre-screen.

@sfc-gh-daxu
sfc-gh-daxu merged commit b9a746e into Snowflake-Labs:master Aug 28, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants