Command Reference
Complete reference for all FileFortress CLI commands
This page provides detailed documentation for all available FileFortress CLI commands. Each command includes syntax, parameters, options, and usage examples.
init - Initialize Device
Register your device with FileFortress and set up the local configuration.
Syntax
filefortress init --code <registration_code> [options]
Required Parameters
Parameter | Description | Example |
---|---|---|
--code |
Registration code from your dashboard | --code ABC123XYZ |
Optional Parameters
Parameter | Description | Default |
---|---|---|
--use-defaults |
Use system defaults for device name and type | false |
--name |
Custom name for this device | Computer name |
--type |
Device type (desktop, mobile, server, laptop, tablet) | Auto-detected |
--force |
Force re-registration if device already registered | false |
Examples
filefortress init --code ABC123XYZ --use-defaults
filefortress init --code ABC123XYZ --name "My Work Laptop" --type laptop
filefortress init --code ABC123XYZ --force
remotes - Manage Cloud Storage
Manage connections to cloud storage providers like Google Drive, Dropbox, and OneDrive.
Available Subcommands
remotes add
- Add new cloud storage
Interactive command to add a new cloud storage provider.
filefortress remotes add
Supports: Google Drive, Dropbox, OneDrive, Box, and more.
remotes list
- List connected storage
Display all connected cloud storage accounts.
filefortress remotes list [--detailed]
Use --detailed
for additional information about each remote.
remotes show
- Show remote details
Display detailed information about a specific remote.
filefortress remotes show <remote_name>
remotes remove
- Remove cloud storage
Remove a connected cloud storage account.
filefortress remotes remove <remote_name> [--force]
Use --force
to skip confirmation prompt.
remotes scan
- Scan for files
Scan connected storage for files and update the index.
filefortress remotes scan [remote_name] [--full] [--background]
Options:
--full
: Perform full scan instead of incremental--background
: Run scan in background
remotes enrich
- Enrich file metadata
Enhance file metadata with additional information.
filefortress remotes enrich [remote_name] [--type <file_type>]
remotes quota
- Check API quotas
Check API usage and quotas for cloud storage providers.
filefortress remotes quota [remote_name]
Common Usage Examples
filefortress remotes add
filefortress remotes list --detailed
filefortress remotes scan "My Google Drive" --full
find - Search Files
Search for files across all connected cloud storage providers using various criteria.
Available Subcommands
find query
- Search by text and criteria
Search files using text queries and various filters.
filefortress find query [options]
Search Options
Option | Description | Example |
---|---|---|
--text |
Search in file names and content | --text "project report" |
--name |
Search only in file names | --name "*.pdf" |
--extension |
Filter by file extension | --extension pdf,docx |
--size-min |
Minimum file size | --size-min 1MB |
--size-max |
Maximum file size | --size-max 100MB |
--modified-after |
Files modified after date | --modified-after 2024-01-01 |
--modified-before |
Files modified before date | --modified-before 2024-12-31 |
--remote |
Search specific remote only | --remote "Google Drive" |
--limit |
Maximum number of results | --limit 50 |
--format |
Output format (table, json, csv) | --format json |
find duplicates
- Find duplicate files
Find duplicate files across all connected storage.
filefortress find duplicates [options]
Duplicate Search Options
Option | Description | Example |
---|---|---|
--method |
Detection method (hash, name, size) | --method hash |
--min-size |
Minimum file size to check | --min-size 1MB |
--extensions |
File extensions to check | --extensions jpg,png,pdf |
--group-by |
Group results by criteria | --group-by size |
Search Examples
filefortress find query --text "meeting notes"
filefortress find query --name "report" --extension pdf
filefortress find query --size-min 10MB --modified-after 2024-01-01
filefortress find query --text "presentation" --remote "Google Drive"
filefortress find duplicates --method hash --extensions jpg,png,gif
update - Update CLI
Update the FileFortress CLI to the latest version.
filefortress update [options]
Options
Option | Description | Default |
---|---|---|
--check |
Check for updates without installing | false |
--force |
Force update even if already latest version | false |
--beta |
Include beta versions in update check | false |
Examples
filefortress update --check
filefortress update
quota - Monitor API Usage
Monitor API usage and quotas for connected cloud storage providers.
Available Subcommands
quota status
- Show current usage
Display current API usage and limits for all or specific remotes.
filefortress quota status [remote_name] [--detailed]
quota sync
- Sync quota information
Refresh quota information from cloud providers.
filefortress quota sync [remote_name]
Examples
filefortress quota status --detailed
filefortress quota status "Google Drive"
config - Manage Configuration
Manage CLI configuration settings and preferences.
Available Subcommands
config list
- List all settings
Display all configuration settings and their current values.
filefortress config list [--format table|json]
config get
- Get specific setting
Get the value of a specific configuration setting.
filefortress config get <key>
config set
- Set configuration value
Set a configuration value.
filefortress config set <key> <value>
config delete
- Delete setting
Delete a configuration setting (revert to default).
filefortress config delete <key>
Common Configuration Settings
Setting | Description | Default |
---|---|---|
output.format |
Default output format for commands | table |
search.limit |
Default number of search results | 25 |
scan.auto |
Automatically scan remotes periodically | true |
logging.level |
Logging verbosity level | info |
Examples
filefortress config set search.limit 50
filefortress config set output.format json
filefortress config list
feedback - Submit Feedback
Submit feedback, bug reports, or feature requests directly from the CLI.
Available Subcommands
feedback create
- Submit new feedback
Submit new feedback, bug report, or feature request.
filefortress feedback create [options]
Options
Option | Description | Values |
---|---|---|
--type |
Type of feedback | bug, feature, general |
--title |
Brief title for the feedback | Text string |
--message |
Detailed feedback message | Text string |
--priority |
Priority level | low, medium, high |
feedback list
- List your feedback
List all feedback you've submitted.
filefortress feedback list [--status open|closed|all]
feedback show
- Show feedback details
Show detailed information about specific feedback.
filefortress feedback show <feedback_id>
Examples
filefortress feedback create --type bug --title "Search not working" --message "Search returns no results for existing files"
filefortress feedback create --type feature --title "Add file preview" --priority medium
filefortress feedback list --status open
device - Device Management
Manage device information and registration status.
filefortress device info
Displays information about the current device including:
- Device ID and name
- Device type
- Registration status
- Last sync time
- Connected remotes count
Example Output
Device Information: ID: abc123-def456-ghi789 Name: My Work Laptop Type: laptop Status: Registered Last Sync: 2024-01-15 14:30:22 Connected Remotes: 3