Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ and versions are tracked in the repo-root `VERSION` file.

## [Unreleased]

## [0.2.0] - 2026-10-10

### Changed

- Align the reference consumer, compatibility matrix, release evidence, and
documentation with the Base-CLI 0.5.0 API line; successful telemetry spans
now assert the 0.5.0 `status=OK` lifecycle contract.
documentation with the released Base-CLI 0.5.x API line; the lockfile now
resolves the published Base-CLI 0.5.1 patch release.

## [0.1.0] - 2026-09-02

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ python -m pip install ".[dev]"
```

The package requires Python 3.10 or newer and pins the supported Base-CLI line
to `>=0.5.0,<0.6`. This checkout targets the next demo release after `v0.1.0`;
to `>=0.5.0,<0.6`. This checkout prepares demo release `v0.2.0`;
demo release versioning remains separate from framework versioning.

## Documentation
Expand All @@ -155,8 +155,8 @@ release. To start with a minimal consumer rather than the full demo, use the

For framework-level material, start at the
[Base-CLI repository](https://github.com/basefoundry/base-cli), its
[getting-started guide](https://github.com/basefoundry/base-cli/blob/v0.5.0/README.md#quick-start),
or the [public API reference](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/api-reference.md).
[getting-started guide](https://github.com/basefoundry/base-cli/blob/v0.5.1/README.md#quick-start),
or the [public API reference](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/api-reference.md).

## Repository shape

Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.1.0
0.2.0
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,5 +26,5 @@ the complete Northstar consumer:

For the framework's complete material, start at the
[Base-CLI repository](https://github.com/basefoundry/base-cli), its
[getting-started guide](https://github.com/basefoundry/base-cli/blob/v0.5.0/README.md#quick-start),
or the [public API reference](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/api-reference.md).
[getting-started guide](https://github.com/basefoundry/base-cli/blob/v0.5.1/README.md#quick-start),
or the [public API reference](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/api-reference.md).
8 changes: 4 additions & 4 deletions docs/learning-path.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,10 @@ Open `src/base_cli_demo/cli.py` while following the examples:
repository conventions mandatory.

For deeper framework context, continue with the Base-CLI
[API reference](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/api-reference.md),
[consumer profiles](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/consumer-profiles.md),
[output contracts](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/output-contracts.md),
[JSON contracts](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/json-contracts.md),
[API reference](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/api-reference.md),
[consumer profiles](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/consumer-profiles.md),
[output contracts](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/output-contracts.md),
[JSON contracts](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/json-contracts.md),
and [testing guide](https://github.com/basefoundry/base-cli/blob/main/docs/testing.md).

## Current behavior and future scope
Expand Down
8 changes: 4 additions & 4 deletions docs/should-i-use-base-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## Status and compatibility

As of this guide, the target Base-CLI release is `0.5.0`; the package is pre-1.0
As of this guide, the target Base-CLI release is `0.5.1`; the package is pre-1.0
and classified as Beta. The demo tests the released `>=0.5.0,<0.6` line. This
is not a promise that every future pre-1.0 minor line
is compatible: Base-CLI's published policy treats patch releases as compatible
and allows a minor release before 1.0 to be a compatibility boundary. Read the
[API stability policy](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/api-stability.md)
and [migration notes](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/migrations.md)
[API stability policy](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/api-stability.md)
and [migration notes](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/migrations.md)
when changing the dependency range. The demo's lockfile records a reproducible
resolved environment; readers moving to the 0.5 line should also read the
[0.5 migration notes](https://github.com/basefoundry/base-cli/blob/main/docs/migration-0.5.md).
Expand Down Expand Up @@ -63,7 +63,7 @@ does not follow a future 0.6 line automatically.
| Base-CLI with Click or Typer | A shared lifecycle and documented automation/output boundary around a familiar parser. | One more dependency, an integration model to learn, and compatibility work as the framework evolves. |

For the parser-focused comparison maintained by the framework project, see its
[framework choice guide](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/framework-choice.md).
[framework choice guide](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/framework-choice.md).
For primary references, see the official
[argparse documentation](https://docs.python.org/3/library/argparse.html),
[Click documentation](https://click.palletsprojects.com/), and
Expand Down
2 changes: 1 addition & 1 deletion docs/use-in-your-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ consumer-owned configuration, and structured output.
The `App` and `attach` calls establish the framework boundary; the Click
function remains your command. See the framework's
[consumer quickstart](https://github.com/basefoundry/base-cli/blob/main/docs/consumer-quickstart.md)
and [API reference](https://github.com/basefoundry/base-cli/blob/v0.5.0/docs/api-reference.md)
and [API reference](https://github.com/basefoundry/base-cli/blob/v0.5.1/docs/api-reference.md)
for the public interfaces.
6 changes: 3 additions & 3 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading