Skip to main content

feincms3-api-cli

The feincms3 content API from the command line, for people and for agents with a shell. It talks HTTP with a token, so it works against any site with the API, without the site's code. Standard library only.

uvx feincms3-api-cli --help        # or: uv tool install feincms3-api-cli

Installed, the command is also f3api, which the examples use; with uvx, write uvx feincms3-api-cli instead.

Sites

A site is the API's URL and a token (create one in the admin, or with ./manage.py f3api_token):

f3api site add example https://example.com/api/   # asks for the token
f3api site list
f3api --site other list pages                     # the first site is the default

F3API_URL and F3API_TOKEN replace the default site (not one named with --site), F3API_SITE names the default. Sites are kept in ~/.config/f3api/sites.json (readable by you only).

Reading

Everything prints JSON:

f3api resources
f3api schema                       # region sets and the plugins allowed per region
f3api schema pages.page            # one type's fields
f3api list pages -f language_code=de -q angebot --fields title,path
f3api get pages 17 --expand        # with meta.references
f3api find /de/angebot/
f3api plugin pages 17 pages.button 103

Writing

Writes are dry runs unless --apply is given: run once, look at the result and its meta.warnings, then run again with --apply.

Writes send the ETag of the object as it was last read with f3api (get, find, list --content), so a write fails with exit code 4 if someone changed the object since, instead of overwriting their change. Read it again, or pass --etag or --force.

f3api get pages 17 > page.json
f3api update pages 17 <<'EOF'
{"fields": {"title": "Unser Angebot"}}
EOF
f3api update pages 17 changes.json --apply
f3api content pages 17 regions.json --apply        # replace the regions given
f3api update-plugin pages 17 pages.button 103 --apply <<'EOF'
{"button_label": "Kontakt"}
EOF
f3api create pages new-page.json --apply
f3api delete articles 3 --apply
f3api cache-clear pages 17
f3api upload team.jpg              # prints {"upload": "…"} to use in fields
f3api batch subtree.json --apply   # several writes in one transaction

In a batch, operations without an etag get the one last read.

Errors

Errors go to stderr with their paths:

f3api: 422 The data isn't valid.
  fields.slug: This field is required.
  content.main[2].fields.text: …

Exit codes: 0 done, 1 failed, 2 usage, 3 invalid data, 4 conflict (ETag, references), 5 not found, 6 not allowed.

Metadata

Release files for feincms3-api-cli 0.0.2

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

Source distribution (sdist)

Source distribution for feincms3-api-cli 0.0.2
File Size Uploaded Provenance Actions
feincms3_api_cli-0.0.2.tar.gz 8.3 kB With provenance Details for feincms3_api_cli-0.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for feincms3-api-cli 0.0.2
File Interpreter ABI Platform Actions
feincms3_api_cli-0.0.2-py3-none-any.whl Python 3 none any Details for feincms3_api_cli-0.0.2-py3-none-any.whl

Total release size: 18.5 kB

Release files / feincms3_api_cli-0.0.2.tar.gz

Download URL feincms3_api_cli-0.0.2.tar.gz
Size 8.3 kB
Tags Source
SHA-256 checksum
How to use checksums
fc05059937df6c59a25ee7f2fafec7d316230cd8699f685f098b6d6087f5fba2
BLAKE2b-256 checksum
How to use checksums
50dd9b5b8327c3bcbd01f911de2f04238dbf6e111f471b69bc2cd4c135bf44d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Release files / feincms3_api_cli-0.0.2-py3-none-any.whl

Download URL feincms3_api_cli-0.0.2-py3-none-any.whl
Size 10.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3a6cb875cc30db22c664fbeca823fa47745d9ed07d9f08f3fcbdaaecd5492d85
BLAKE2b-256 checksum
How to use checksums
513e498c96b5a9fa4b02a5b1ca54235c376ca26e2e6f979554aa93993310590c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Security for feincms3-api-cli 0.0.2

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for feincms3_api_cli-0.0.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

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.

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