CLI for common MaybeAI spreadsheet operations
Project description
maybeai-sheet-cli
CLI for MaybeAI spreadsheet operations.
maybeai-sheet wraps the MaybeAI spreadsheet HTTP APIs behind a stable command-line interface for humans, CI jobs, and agents.
Install
On Debian/Ubuntu and other PEP 668 systems, do not use bare pip install on system Python. Use pipx (recommended for CLIs):
sudo apt install -y pipx python3-venv
pipx ensurepath
# re-login or: source ~/.bashrc
pipx install maybeai-sheet-cli
maybeai-sheet --version
For local venvs or macOS/dev machines, plain pip is fine:
pip install maybeai-sheet-cli
Upgrade to the latest release:
maybeai-sheet update # when installed via pip or pipx
pipx upgrade maybeai-sheet-cli # alternative on pipx installs
Install a specific version:
maybeai-sheet update --version 0.3.0
pipx install maybeai-sheet-cli==0.3.0 --force # pipx reinstall pin
Uninstall:
pipx uninstall maybeai-sheet-cli
# not: pip uninstall -U (-U is invalid for uninstall)
Requirements
- Python 3.10+
MAYBEAI_API_TOKEN
Configure
Set your API token:
export MAYBEAI_API_TOKEN="YOUR_TOKEN"
Optional global flags:
--base-urlto point at a different MaybeAI API host--output json|table|yaml--timeout <seconds>--verbose
Quick Start
Read a workbook:
maybeai-sheet sheet read --doc-id abc123
List worksheets:
maybeai-sheet sheet worksheets --doc-id abc123
Read headers from a worksheet:
maybeai-sheet sheet headers --doc-id abc123 --gid 3
Create a workbook:
maybeai-sheet workbook create --title "Board Pack"
Upload a workbook-style .xlsx through the default Excelize path:
maybeai-sheet workbook create-from-file ./report.xlsx
Import a large table-like .xlsx into SheetTable/PG:
maybeai-sheet workbook create-from-file ./large-table.xlsx --engine postgres
Append rows and verify:
maybeai-sheet sheet append --doc-id abc123 --gid 3 --rows rows.json --verify
Make a workbook public for viewers:
maybeai-sheet share visibility --doc-id abc123 --visibility public --public-permission viewer
Commands
updateworkbook createworkbook create-from-fileworkbook manifestworkbook capabilitiesshare visibilityshare grantshare permissionshare removeshare listsheet readsheet read-rangesheet read-manysheet named-rangesheet headerssheet worksheetssheet formulassheet write-rangesheet clear-rangesheet appendsheet formula-setsheet formula-batch-setsheet recalculatesheet upsertsheet create-worksheetraw post
Input Rules
- Use
--doc-id,--url, or--urito identify a workbook. - Use
--worksheet-namewhen the endpoint supports it. - Use
--gidfor gid-specific sheet targeting. - File inputs like
--rows,--values,--targets, and--operationsmust be JSON.
Output
Default output is JSON. table is optimized for sheet-like payloads; yaml is also supported.
Development
python3 -m venv .venv
. .venv/bin/activate
pip install -U pip
pip install -e .
Run tests:
python -m unittest discover -s tests -v
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file maybeai_sheet_cli-0.3.0.tar.gz.
File metadata
- Download URL: maybeai_sheet_cli-0.3.0.tar.gz
- Upload date:
- Size: 47.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1cfa000d2bbed88c26cd99727c055ff6caa934edab11035646a6a8bf30748e67
|
|
| MD5 |
4429c6c33887b7642fd2f3b0a3010e61
|
|
| BLAKE2b-256 |
a0def15ef0a52ec823deef14cc10f9c2212051f54f2a4cffed08eb4d913ed375
|
File details
Details for the file maybeai_sheet_cli-0.3.0-py3-none-any.whl.
File metadata
- Download URL: maybeai_sheet_cli-0.3.0-py3-none-any.whl
- Upload date:
- Size: 22.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7d618665904c5b23f17c8b82c1b19ace341ab73d5da15511b7690e76904bbd1f
|
|
| MD5 |
2d9c7ad4b594f399bca24ca61e31f335
|
|
| BLAKE2b-256 |
13d44a020b847980ace4149a8f75716cfc4dcab3f63627e690e40fcdf58a057e
|