Command Line Interface

The built-in command line interface can be used by other applications or by advanced users to control the application. The current implementation allows users to start requests of all types, to register new data sources, etc.

The basic format is as follows:
bitkinex.exe [CMD] {/[OPT1]} {/[OPT2]} ... {/[OPTn]} [URI1] ... {[URIn]}

Where:

[CMD] BitKinex command
[OPT] Optional command parameter
[URI] Uniform Resource Identifier in one of the following forms:
  1. Standard URI:
    [protocol]://{[user]{:[password]}@}[server]{/[path]}

    Example: ftp://john:mypasswd@www.myserver.com/private/john/
    Note: Paths ending with a slash are treated as directories.
  2. BitKinex URI:
    "bitkinex://[fldr1]{|[fldr2]}...{|[fldrn]}|[dsname]|{/[path]}",
    where [fldr1]...[fldrn] and [dsname] identifies the data source in the data source pane.

    Example: "bitkinex://http|Barad-Dur|/mydir/myfile.txt" identifies the "/mydir/myfile.txt" file on the "Barad-Dur" data source which is located in the "Http" folder. This format is useful especially for the UNREG command.
    Note: Please remember that BitKinex URIs must be enclosed in quotation marks (this is necessary due to the "|" character).

Commands

The following commands are supported by the current version:

Command Description Supported parameters
BROWSE Opens a browse window for the specified URI. A temporary data source is created automatically in case no data source matching the URI exists. /noinfo, /noerr, /norest, /result
CP Starts a file transfer request on the selected data source. The source URI must be always specified whereas the destination URI is optional. A temporary data source is created automatically in case no data source matching the source URI exists. The user will be prompted to specify the destination location in case it has been ommited on the command line. /force, /noinfo, /noerr, /norest, /result, /skipsz, /skiptmsz, /binary, /ascii, /delsrc, /auto_exit, /auto_suspend, /auto_pwroff
CRC32 Computes the CRC32 checksum of the file identified by the URI. /force, /noinfo, /noerr, /norest, /result, /skipsz, /skiptmsz, /binary, /ascii, /auto_exit, /auto_suspend, /auto_pwroff
DROP {ALL/ACTIVE/HISTORY/[ID]} Removes a request identified by [ID] from the request list. Use "ALL" instead of a request [ID] in case you want to remove all requests. The command does not affect running requests. /noerr,
DSEDIT Opens a properties dialog for the data source specified by the URI. A temporary data source is created automatically in case no data source matching the URI exists. /noinfo, /noerr, /norest, /result
LIST Retrieves the content of the directory identified by the URI. Use the /result switch to store the file and subdirectory names into a file. A temporary data source is created automatically in case no data source matching the URI exists. This command has been designed to provide directory listings from the the remote console. /force, /noinfo, /noerr, /norest, /result, /auto_exit, /auto_suspend, /auto_pwroff
MD5 Computes the MD5 hash of the file identified by the URI. /force, /noinfo, /noerr, /norest, /result, /skipsz, /skiptmsz, /binary, /ascii, /auto_exit, /auto_suspend, /auto_pwroff
MKDIR Creates a new directory at the location specified by the URI. A temporary data source is created automatically in case no data source matching the URI exists. /force, /noinfo, /noerr, /norest, /result, /auto_exit, /auto_suspend, /auto_pwroff
MIRROR1, MIRROR2 Starts a mirroring request on the selected data source. MIRROR1 corresponds to a "simple" mirroring request, MIRROR2 starts a "synchro" request (files which do not exist at the source location will be removed from the destination). The source URI must always be specified whereas the destination URI is optional. A temporary data source is created automatically in case no data source matching the source URI exists. The user will be prompted to specify the destination location in case it has been ommited on the command line. /force, /noinfo, /noerr, /norest, /result, /skipsz, /skiptmsz, /timing, /binary, /ascii, /auto_exit, /auto_suspend, /auto_pwroff
OPEN Opens the file identified by the URI using a program associated with that file extension. A temporary data source is created automatically in case no data source matching the source URI exists. /force, /noinfo, /noerr, /norest, /result, /skipsz, /skiptmsz, /binary, /ascii, /auto_exit, /auto_suspend, /auto_pwroff
QUIT Terminates BitKinex (if running). /force,
REG Creates a new data source with the server address, login name and password specified in the first URI. The second URI must specify the data source name and location in the data source pane.
It must be in the form {[fldr1]|} ... {[fldrn]|}[datasrc].
Please note that this URI never begins with a protocol specifier. The [fldr1] (if specified) is the name of the first folder under the respective protocol node.
Example: bitkinex.exe reg /noinfo ftp://john:mypasswd@www.myserver.com/documents/archive.zip "mysites|test" creates a new FTP data source called "test" and located in the "mysites" folder.
/noinfo, /noerr, /norest, /rdonly, /result /usenew
REN Renames the file or directory specified by the source URI. A temporary data source is created automatically in case no data source matching the source URI exists. The user will be prompted to specify the destination location in case it has been ommited on the command line. /force, /noinfo, /noerr, /norest, /result, /auto_exit, /auto_suspend, /auto_pwroff
RESTART {ALL/ACTIVE/HISTORY[ID]} Restarts a stopped request identified by [ID]. Use "ALL" instead of a request [ID] in case you want to restart all stopped requests. /noerr,
RESUME {ALL/ACTIVE/HISTORY/[ID]} Resumes a paused request identified by [ID]. Use "ALL" instead of a request [ID] in case you want to resume all paused requests. /noerr,
RM Deletes the file or directory specified by the URI. A temporary data source is created automatically in case no data source matching the URI exists. /force, /noinfo, /noerr, /norest, /result, /auto_exit, /auto_suspend, /auto_pwroff
SHA1 Computes the SHA1 hash of the file identified by the URI. /force, /noinfo, /noerr, /norest, /result, /skipsz, /skiptmsz, /binary, /ascii, /auto_exit, /auto_suspend, /auto_pwroff
SHOW {ALL/ACTIVE/HISTORY/[ID]} Returns status information about a request identified by [ID]. Use "ALL" instead of a request [ID] in case you want to list all requests. This command has been designed to provide status information from the remote console. /noerr,
SIGNAL {[SIGNAL_NAME]} Sends a signal identified by [SIGNAL_NAME]. Requests listening for this signal (if any) will take the action specified on their Signals property page. /noerr,
STOP {ALL/ACTIVE/HISTORY/[ID]} Stops a running request identified by [ID]. Use "ALL" instead of a request [ID] in case you want to stop all running requests. /noerr,
SYNCHRO Starts a synchronization request on the selected data source. The source URI must always be specified whereas the destination URI is optional. A temporary data source is created automatically in case no data source matching the source URI exists. The user will be prompted to specify the destination location in case it has been ommited on the command line. /force, /noinfo, /noerr, /norest, /result, /skipsz, /skiptmsz, /binary, /ascii, /auto_exit, /auto_suspend, /auto_pwroff
UNREG Unregisters (removes) the data source identified by the URI. /noinfo, /noerr, /norest, /result
VIEW Displays the file content identified by the URI. A program associated with that file extension or a text editor specified in the main application settings will be used. A temporary data source is created automatically in case no data source matching the source URI exists. /force, /noinfo, /noerr, /norest, /result, /skipsz, /skiptmsz, /binary, /ascii, /auto_exit, /auto_suspend, /auto_pwroff
WATCH Monitors the status of a server identified by the URI. /noinfo, /noerr, /norest, /result

Parameters

Examples