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.

The clif client exposes 8 commands covering authentication and file management. Commands that interact with stored files require a valid .clif/authdata file in the current working directory — run clif login or clif signup first if you haven’t already.

​
clif signup

Register a new account on a CLIF server and save credentials locally. 
clif signup
Auth required: No The command prompts for a server address, username, and password. Your password is hashed with SHA-256 before being sent — the plaintext is never transmitted. On success, credentials are written to .clif/authdata.
If .clif/authdata already exists in the current directory, the command prints You are already logged in! and exits. Run clif logout first to switch accounts.
Enter the server address:
http://127.0.0.1:8000
Enter your username:
alice
Enter your password:
••••••••••••

​
clif login

Log in to an existing account and save credentials locally. 
clif login
Auth required: No Prompts for a server address, username, and password. The client looks up your user ID from the server using your username, then verifies your password. Credentials are saved to .clif/authdata in the current directory. 
Enter the server address:
http://127.0.0.1:8000
Enter your username:
alice
Enter your password:
••••••••••••

​
clif logout

Remove your local credentials. 
clif logout
Auth required: No Prompts for confirmation before deleting .clif/authdata. Your account and server-side files are not affected. 
Are you sure you want to logout? (y/n)
y

​
clif upload

Upload a file to the server. 
clif upload <file>
Auth required: Yes
​
file
string
required
Path to the local file you want to upload.
The file is sent to the server along with your credentials. The filename is preserved on the server. On success, the server’s response message is printed. 
clif upload report.pdf

File Uploaded

​
clif download

Download a file from the server to the current directory. 
clif download <file>
Auth required: Yes
​
file
string
required
Name of the file on the server to download.
The file is written to the current working directory with its original filename. 
clif download report.pdf

​
clif list

List all files you own on the server. 
clif list
Auth required: Yes Prints Files currently owned by <username>: followed by each filename stored under your account. 
Files currently owned by alice:
report.pdf
notes.txt
backup.tar.gz

​
clif delete

Delete a file from the server. 
clif delete <file>
Auth required: Yes
​
file
string
required
Name of the file on the server to delete.
Deletion is permanent. There is no confirmation prompt and no way to recover a deleted file.
clif delete backup.tar.gz

​
clif info

Show your account details and storage usage. 
clif info
Auth required: Yes Prints your account statistics from the server, including how much of your allocated storage you’ve used. 
User Statistics for alice:
---------------------------------
            Username: alice
            User ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890
            Used Storage: 1234 bytes
            Allocation Limit: 20000 bytes
            Percentage of storage used: 6%

Build docs developers (and LLMs) love

Get started for freeTalk to us