Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/WyattBrashear/CLIF/llms.txt

Use this file to discover all available pages before exploring further.

CLIF (CLI FileStor) is an open-source, self-hostable file storage system that gives you full control over your data. It combines a lightweight Flask REST API server with a Python CLI client, letting you upload, download, list, and manage files from your terminal — no third-party cloud required.

Quickstart

Get CLIF installed and store your first file in under 5 minutes

CLI Commands

Full reference for every clif command and its options

API Reference

Explore the REST API endpoints for programmatic file access

Self-Hosting

Deploy your own CLIF server and configure storage limits

What CLIF gives you

CLIF is designed for developers and power users who want a simple, self-controlled alternative to cloud storage services. You run the server, you own the data.

CLI-First Design

Manage all your files from the terminal with intuitive commands like clif upload, clif download, and clif list

Simple Authentication

SHA-256 password hashing keeps credentials secure. Auth data is stored locally in .clif/authdata

Storage Allocation

Administrators set per-user storage limits in CLIF.json. Users can check their usage with clif info

pip Installable

Install both the client and server from PyPI with a single pip install clifilestor command

How it works

CLIF has two components that work together:
  • The server (clif-server) runs a Flask HTTP API that stores files on disk and tracks metadata in SQLite. You deploy it wherever you want — a home server, a VPS, or a local machine.
  • The client (clif) connects to any CLIF server over HTTP, authenticates with your credentials, and lets you manage files with simple CLI commands.
1

Install CLIF

Install both the client and server with pip:
pip install clifilestor
2

Start your server

Run the server (optionally configure it with CLIF.json first):
clif-server
3

Sign up and connect

Create an account on your server:
clif signup
4

Upload your first file

Start storing files immediately:
clif upload myfile.txt

Build docs developers (and LLMs) love