Skip to main content

Almanac CLI

A thin client for hosted Almanac. Each command is one POST /v2/cli carrying the words, stdin and the bytes of any local files the words name (@FILE, --patch FILE, --cursor @FILE, --from FILE, --file FILE, wiki add PATH). The API parses the same grammar from shared/commands and owns data and write outcomes; the CLI only reads those files, signs in, and saves results and downloads.

almanac login
almanac search "pricing" --from alex@example.com
almanac list --kind task --state open
almanac read people/alex-kim
almanac history --since chg_48211
almanac email reply REF --body @reply.md --draft
almanac messages send --in '#general' --body 'Hello'
almanac calendar respond REF accept
almanac files share REF --add-with alex@example.com
almanac accounts
almanac help "forward email"

Data commands print the API's JSON document. Help prints plain text. Read results contain items, write results item; a failure is {"ok": false, "error": PROBLEM} with the API's RFC 9457 Problem. Save a full document with --output FILE; stdout then omits items and includes the file path and count. --cursor @FILE continues from the next saved in that file. Downloads use --output-dir DIR and never replace an existing file.

Read before editing; pass the returned revision as --expect. Intents such as archive, react and restore need no revision. Every write receives a request key; repeat it only with identical input. Unknown write outcomes are never retried blindly.

One credential is chosen, never falling through: --user (stored sign-in), --token, ALMANAC_TOKEN_FILE (a sandbox run's token, re-minted into the file), ALMANAC_TOKEN, then the stored sign-in from almanac login. ALMANAC_API_URL selects the server.

almanac batch reads up to 20 JSON argv arrays from stdin and sends them as one request. Every write line needs its own explicit --request-key. The whole batch is validated before it starts, then runs in order and reports each result.

Use --draft on email send, email reply, or email forward to hold an Almanac draft (dft_…); use drafts edit|send|archive|restore to manage it. Find held drafts with almanac list --kind draft, then inspect a returned ref with almanac read DRAFT_REF before editing or sending it.

Public research uses apps web sources and apps web describe OPERATION for available sources and native filters. apps web search QUERY --source SOURCE --parameters @filters.json --output result.json preserves the original data, resources, assets and continuation. Read a returned resource with read RESOURCE --from result.json; choose --operation when several are offered. Download an original asset with download ASSET --from result.json --variant VARIANT --output-dir ./files. Resource and asset IDs belong to that saved result; they are not persistent account refs. Web cursors accept the returned token or --cursor @result.json (its pagination.next_cursor), with the same source and filters.

read URL recognizes supported Drive, Gmail, Calendar and Slack item URLs and uses the connected account; use --account when ambiguous. Unsupported private app URLs fail explicitly rather than entering public research. Public URLs use the existing web reader. Web results preserve source-native pagination and availability; a page of results is not proof of complete coverage.

Metadata

Release files for the-almanac 2.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for the-almanac 2.0.1
File Interpreter ABI Platform Actions
the_almanac-2.0.1-py3-none-any.whl Python 3 none any Details for the_almanac-2.0.1-py3-none-any.whl

Release files / the_almanac-2.0.1-py3-none-any.whl

Download URL the_almanac-2.0.1-py3-none-any.whl
Size 63.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b55cb15d6eea28ac06603ec36ef30c50e6248cd613fa4cfd267fdf52e345805a
BLAKE2b-256 checksum
How to use checksums
ec3d33635cd95acf3a62ce447445698bfb80e593d5ed0432ea34932272f6950a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for the-almanac 2.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.0.1 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page