eph

command module
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 21, 2025 License: MIT Imports: 1 Imported by: 0

README

GitHub release Go Report Card coverage GitHub Downloads GoDoc License

eph

eph is the official client for https://api.ephemeralfiles.com.

Getting started

Install

Install from the release binary.

$ mkdir $HOME/.bin
$ curl -L https://github.com/ephemeralfiles/eph/releases/download/v0.2.0/eph_0.2.0_linux_amd64 --output $HOME/.bin/eph
$ chmod +x $HOME/.bin/eph
$ # add $HOME/.bin in your PATH
$ export PATH=$HOME/.bin:$PATH
$ # Add the new PATH to your .bashrc
$ echo 'export PATH=$HOME/.bin:$PATH' >> $HOME/.bashrc
Configure
  • First of all, you need to create an account on https://api.ephemeralfiles.com
  • Generate a token in your account
  • Use the generated token to configure the client
$  eph config -t "generated-token"
Configuration saved

You should be able to use the client. Check with this command:

$ eph check
Token configuration:
  email: ********
  expiration Date: 2025-07-02 21:39:26
Box configuration:
  capacity: 5120 MB
  used: 0 MB
  remaining: 5120 MB

Working with Organizations

Organizations allow teams to share storage and collaborate on files. The eph org command provides comprehensive organization management.

Listing Organizations

View all organizations you have access to:

$ eph org list
ID                                    NAME    STORAGE         SUBSCRIPTION  ROLE
abc-123-def                          eph1    2.5GB / 10GB    Active        Admin
xyz-789-uvw                          eph2    500MB / 5GB     Active        Member
Setting Default Organization

Set a default organization to avoid specifying it for every command:

$ eph org use eph1
Default organization set to 'eph1'

# Clear default organization
$ eph org use --clear
Default organization cleared
Organization Information

View detailed organization information:

$ eph org info
Organization: eph1
ID: abc-123-def
Storage: 2.5GB / 10GB (25.0%)
Subscription: Active
Members: 5
Files: 147 (142 active, 5 expired)
Uploading Files to Organizations

Upload files to your organization with optional tags:

# Upload to default organization
$ eph org up -i quarterly-report.pdf

# Upload with tags for better organization
$ eph org up -i invoice.pdf --tags "invoice,q1,2024"

# Override default organization
$ eph org up -i file.pdf --org eph2
Listing Organization Files

List files in an organization with various filtering options:

# List all files
$ eph org ls

# Filter by tags
$ eph org ls --tags "invoice,2024"

# Show recent files
$ eph org ls --recent --limit 10

# Show expired files
$ eph org ls --expired

# JSON output
$ eph org ls --format json
Downloading Organization Files

Download files from an organization:

# Download with original filename
$ eph org dl -i file-uuid-123

# Download with custom filename
$ eph org dl -i file-uuid-123 -o custom-name.pdf
Deleting Organization Files

Delete files from an organization:

# With confirmation prompt
$ eph org rm -i file-uuid-123

# Skip confirmation
$ eph org rm -i file-uuid-123 --force
Storage Management

Monitor organization storage usage:

$ eph org storage
Organization: eph1
Storage Limit:    10.00 GB
Used:             2.50 GB
Available:        7.50 GB
Usage:            25%
Status:           Normal
Organization Statistics

View detailed organization statistics:

$ eph org stats
Organization ID:  abc-123-def
Files:            147
Active:           142
Expired:          5
Total Size:       2.5 GB
Members:          5

View most-used tags in an organization:

$ eph org tags --limit 10
TAG           COUNT
invoice       45
2024          38
report        25
contract      18
Multi-Organization Workflow

Work with multiple organizations efficiently:

# Set default organization
$ eph org use eph1
$ eph org up -i file1.pdf

# Temporarily use different organization
$ eph org up -i file2.pdf --org eph2

# Check storage across organizations
$ eph org storage --org eph1
$ eph org storage --org eph2

Documentation

Overview

Package main is the entry point for the eph CLI application. eph is the official command-line client for ephemeralfiles.com, providing file upload, download, and management capabilities with end-to-end encryption support.

Directories

Path Synopsis
Package cmd provides the command-line interface commands for the eph CLI tool.
Package cmd provides the command-line interface commands for the eph CLI tool.
pkg
cmdutil
Package cmdutil provides common utilities and helper functions for command-line operations.
Package cmdutil provides common utilities and helper functions for command-line operations.
config
Package config provides configuration management for the ephemeralfiles CLI.
Package config provides configuration management for the ephemeralfiles CLI.
dto
Package dto provides data transfer objects for the ephemeralfiles API.
Package dto provides data transfer objects for the ephemeralfiles API.
ephcli
Package ephcli provides progress bar functionality for file operations.
Package ephcli provides progress bar functionality for file operations.
github
Package github provides functionality for interacting with GitHub releases and checking for updates to the ephemeral files CLI.
Package github provides functionality for interacting with GitHub releases and checking for updates to the ephemeral files CLI.
logger
Package logger provides structured logging utilities for the ephemeral files CLI.
Package logger provides structured logging utilities for the ephemeral files CLI.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL