Skip to content

Conversation

@el10savio
Copy link
Contributor

Hi folks, big fan of Iceberg! I noticed a tiny change in the cli docs. Correcting it here.

Rationale for this change

Fix docs.

Are these changes tested?

No tests against docs.

Are there any user-facing changes?

Should now reflect in https://py.iceberg.apache.org/cli/#python-cli

Hi folks, big fan of Iceberg! I noticed a tiny change in the cli docs. Correcting it here
Copy link
Contributor

@Fokko Fokko left a comment

Choose a reason for hiding this comment

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

This was actually a joke from my end, xor referring to exclusive-or :)

Copy link
Contributor

@geruh geruh left a comment

Choose a reason for hiding this comment

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

Hey @el10savio,

Thanks for fixing this! It looks like this help message is out of date would you mind updating the output? We could also fix in a follow up

Options:
  --catalog TEXT
  --verbose BOOLEAN
  --output [text|json]
  --ugi TEXT
  --uri TEXT
  --credential TEXT
  --help                Show this message and exit.

Commands:
  create      Operation to create a namespace.
  describe    Describe a namespace or a table.
  drop        Operations to drop a namespace or table.
  files       List all the files of the table.
  list        List tables or namespaces.
  list-refs   List all the refs in the provided table.
  location    Return the location of the table.
  properties  Properties on tables/namespaces.
  rename      Rename a table.
  schema      Get the schema of the table.
  spec        Return the partition spec of the table.
  uuid        Return the UUID of the table.
  version     Print pyiceberg version.

@el10savio
Copy link
Contributor Author

Sure thing, I can update my PR to have the above output

@el10savio el10savio requested a review from geruh December 4, 2025 20:24
@el10savio el10savio changed the title docs: Fix minor misspell in cli.md docs: Update pyiceberg CLI help docs Dec 4, 2025
Copy link
Contributor

@geruh geruh left a comment

Choose a reason for hiding this comment

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

LGTM! The CLI is super cool! It gives you a easy way to query a catalog and view table data.

@el10savio
Copy link
Contributor Author

Thanks @geruh and @Fokko!
It looks like I cant merge the PR in, if you could merge it in that'd be great :D

Copy link
Contributor

@kevinjqliu kevinjqliu left a comment

Choose a reason for hiding this comment

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

LGTM

ran make docs-serve locally. looks great!
Screenshot 2025-12-04 at 1 52 21 PM

@kevinjqliu kevinjqliu merged commit abae20f into apache:main Dec 4, 2025
3 checks passed
@kevinjqliu
Copy link
Contributor

thanks for updating the docs @el10savio and thanks for the review everyone :)

@kevinjqliu
Copy link
Contributor

also kicking off the release docs github action https://github.com/apache/iceberg-python/actions/runs/19945154037

@kevinjqliu
Copy link
Contributor

anddddd its live! https://py.iceberg.apache.org/cli/

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.

4 participants