`homeboy file` command reference

Last updated: July 31, 2026

Generated from the clap command tree. This page is the complete synopsis, argument, flag, and subcommand surface for this command family.

Concepts, recipes, and contracts are hand-written in docs/commands/file.md.

Global flags apply to every command and are documented once in the root command reference.

homeboy file

sh
homeboy file <COMMAND>

Remote file operations

SubcommandSummary
homeboy file listList directory contents
homeboy file readRead file content
homeboy file writeWrite content to file (from stdin)
homeboy file mkdirCreate a directory
homeboy file deleteDelete a file or directory
homeboy file renameRename or move a file
homeboy file findFind files by name pattern
homeboy file grepSearch file contents
homeboy file downloadDownload a file or directory from remote server
homeboy file copyCopy a file or path between local and remote targets
homeboy file syncSync a directory between local and remote targets without deleting extras
homeboy file editEdit file with line-based or pattern-based operations

homeboy file list

sh
homeboy file list <PROJECT_ID> <PATH>

List directory contents

ArgumentRequiredDescription
<PROJECT_ID>yesProject ID
<PATH>yesRemote directory path

homeboy file read

sh
homeboy file read [OPTIONS] <PROJECT_ID> <PATH>

Read file content

ArgumentRequiredDescription
<PROJECT_ID>yesProject ID
<PATH>yesRemote file path
OptionValueDescription
--rawflagOutput raw content only (no JSON wrapper)

homeboy file write

sh
homeboy file write [OPTIONS] <PROJECT_ID> <PATH>

Write content to file (from stdin)

ArgumentRequiredDescription
<PROJECT_ID>yesProject ID
<PATH>yesRemote file path
OptionValueDescription
--applyflagApply the destructive write. Without this flag, prints a plan only

homeboy file mkdir

sh
homeboy file mkdir [OPTIONS] <PROJECT_ID> <PATH>

Create a directory

ArgumentRequiredDescription
<PROJECT_ID>yesProject ID
<PATH>yesRemote directory path
OptionValueDescription
--applyflagApply the directory creation. Without this flag, prints a plan only

homeboy file delete

sh
homeboy file delete [OPTIONS] <PROJECT_ID> <PATH>

Delete a file or directory

ArgumentRequiredDescription
<PROJECT_ID>yesProject ID
<PATH>yesRemote path to delete
OptionValueDescription
-r, --recursiveflagDelete directories recursively
--applyflagApply the destructive delete. Without this flag, prints a plan only

homeboy file rename

sh
homeboy file rename [OPTIONS] <PROJECT_ID> <OLD_PATH> <NEW_PATH>

Rename or move a file

ArgumentRequiredDescription
<PROJECT_ID>yesProject ID
<OLD_PATH>yesCurrent path
<NEW_PATH>yesNew path
OptionValueDescription
--applyflagApply the rename/move. Without this flag, prints a plan only

homeboy file find

sh
homeboy file find [OPTIONS] <PROJECT_ID> <PATH>

Find files by name pattern

ArgumentRequiredDescription
<PROJECT_ID>yesProject ID
<PATH>yesDirectory path to search
OptionValueDescription
--name<NAME>Filename pattern (glob, e.g., "*.php")
--file-type<type>File type: f (file), d (directory), l (symlink)
--max-depth<MAX_DEPTH>Maximum directory depth

homeboy file grep

sh
homeboy file grep [OPTIONS] <PROJECT_ID> <PATH> <PATTERN>

Search file contents

ArgumentRequiredDescription
<PROJECT_ID>yesProject ID
<PATH>yesDirectory path to search
<PATTERN>yesSearch pattern
OptionValueDescription
--name<NAME>Filter files by name pattern (e.g., "*.php")
--max-depth<MAX_DEPTH>Maximum directory depth
-i, --ignore-caseflagCase insensitive search

homeboy file download

sh
homeboy file download [OPTIONS] <PROJECT_ID> <PATH> [LOCAL_PATH]

Download a file or directory from remote server

ArgumentRequiredDescription
<PROJECT_ID>yesProject ID
<PATH>yesRemote file path
[LOCAL_PATH]noLocal destination path (defaults to current directory)
OptionValueDescription
-r, --recursiveflagDownload directories recursively

homeboy file copy

sh
homeboy file copy [OPTIONS] <SOURCE> <DESTINATION>

Copy a file or path between local and remote targets

ArgumentRequiredDescription
<SOURCE>yesSource: local path or server_id:/path
<DESTINATION>yesDestination: local path or server_id:/path
OptionValueDescription
-r, --recursiveflagCopy directories recursively
-c, --compressflagCompress data during transfer
--dry-runflagShow what would be copied without doing it
--exclude<EXCLUDE>Exclude patterns for recursive server-to-server copies

homeboy file sync

sh
homeboy file sync [OPTIONS] <SOURCE> <DESTINATION>

Sync a directory between local and remote targets without deleting extras

ArgumentRequiredDescription
<SOURCE>yesSource: local path or server_id:/path
<DESTINATION>yesDestination: local path or server_id:/path
OptionValueDescription
-c, --compressflagCompress data during transfer
--dry-runflagShow what would be copied without doing it
--exclude<EXCLUDE>Exclude patterns for recursive server-to-server copies

homeboy file edit

sh
homeboy file edit [OPTIONS] <PROJECT_ID> <FILE_PATH>

Edit file with line-based or pattern-based operations

ArgumentRequiredDescription
<PROJECT_ID>yesProject ID
<FILE_PATH>yesRemote file path
OptionValueDescription
-n, --dry-runflagShow changes without applying
-f, --forceflagApply even if multiple pattern matches (warns by default)
--replace-line<REPLACE_LINE>no help text
--replace-line-content<CONTENT>no help text
--insert-after<INSERT_AFTER>no help text
--insert-after-content<CONTENT>no help text
--insert-before<INSERT_BEFORE>no help text
--insert-before-content<CONTENT>no help text
--delete-line<DELETE_LINE>no help text
--delete-lines<START> <END>no help text
--replace-pattern<PATTERN>no help text
--replace-pattern-content<CONTENT>no help text
--replace-all-pattern<REPLACE_ALL_PATTERN>no help text
--replace-all-content<CONTENT>no help text
--delete-pattern<PATTERN>no help text
--append<CONTENT>no help text
--prepend<CONTENT>no help text

More in Commands

All Homeboy Docs View all Commands