Skip to content

[Community] Python API/CLI client for scripting and automation #1164

@xx025

Description

@xx025

Hi,

I've been using HFS for local file sharing and really like the admin UI and the way it just works. When I wanted to script things (list files, upload/download from the terminal, or drive HFS from Python), I didn't find an official CLI or Python SDK, so I wrote a small community project that might be useful for others in the same situation.

hfsapi — Python API + CLI for HFS:

The project was mostly developed with AI assistance, but I've been using it for basic operations (login, list, upload, download, mkdir, delete, config/VFS read) and it works reliably for those use cases. It's still early and minimal, and it already covers:

  • CLI: hfs login, hfs list, hfs upload, hfs download, hfs mkdir, hfs delete, hfs config get, hfs vfs, etc., with credentials stored locally after one login.
  • Python API: HFSClient for login, get_file_list / list_entries, upload_file, create_folder, delete_file, get_config / set_config, get_vfs(), plus small helpers for list entry metadata and permissions.

So if anyone needs to automate HFS from the command line or from Python (CI, backups, sync scripts, etc.), this might help. It's not an official HFS project—just something I built to scratch my own itch and am sharing in case it's useful.

Thanks for HFS.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions