Freenet Text Mode Client Interface (TMCI)

The Freenet Text Mode Client Interface (TMCI) is a simple command-line interface to Freenet. It allows you to do things like insert content into Freenet, and to request information from Freenet. It is sometimes referred to as the telnet interface.

To access TMCI, you can use a telnet program to connect to the node (by default to port 2323). You need to make sure that TCMI is enabled in the FProxy configuration page, which is here if your node is running locally: http://localhost:8888/config/∞

From a command prompt, enter this:

You should get back a response that starts something like this:

This is followed by a brief list of commands.

TMCI commands

Command	Description
GET:freenet_key	Fetch a file from Freenet with the given key. The contents of the file are echoed to the console.
PUT: Multiple lines of text, like this, ended by a . on a line by itself .	Insert the file into Freenet and return the key that was used.
PUT:A single line of text	Use the single line of text as a file to insert to Freenet, and return the key used.
GETCHK: Multiple lines of text, like this, ended by a . on a line by itself .	Get the key that would be used if the file was inserted to Freenet, but dont actually insert the file.
GETCHK:A single line of text	Get the CHK key that would be returned if the line was inserted to Freenet, but don't actually do the insert.
PUTFILE:filename PUTFILE:filename#mimetype	Insert to Freenet the file with full path called filename. Optionally include the MIME type of the file, for example text/html.
GETFILE:freenet_key	Fetch a key from Freenet and save it to a file. If the key includes a filename we will use it, but we will not overwrite local files.
GETCHKFILE:filename	Get the CHK key that would be returned if we inserted the file to Freenet, but don't actually do the insert.
PUTDIR:path PUTDIR:path#defaultfile	Insert an entire directory to Freenet from disk. Optionally include a default filename
GETCHKDIR:path GETCHKDIR:path#defaultfile	Get the key that would be returned if we'd put the entire directory from disk.
MAKESSK	Create an SSK keypair.
PUTSSK:insert_uri;redirect_url	Insert an SSK redirect to a file already inserted.
PUTSSKDIR:insert_uri#path PUTSSKDIR:insert_uri#path#defaultfile	Insert an entire directory to an SSK. Optionally include a default file.
PLUGLOAD:	Load plugin. (use "PLUGLOAD:?" for more info)
PLUGLIST	List all loaded plugins.
PLUGKILL:	Unload the plugin with the given ID (see PLUGLIST).
CONNECT:	see ADDPEER: below
CONNECT:\r\n	see ADDPEER:\r\n below
DISCONNECT:	see REMOVEPEER: below
ADDPEER:	add a peer from its ref in a file/url.
ADDPEER:\r\n	add a peer by entering a noderef directly.
DISABLEPEER:	disable a peer by providing it's ip+port, name, or identity
ENABLEPEER:	enable a peer by providing it's ip+port, name, or identity
SETPEERLISTENONLY:	set ListenOnly on a peer by providing it's ip+port, name, or identity
UNSETPEERLISTENONLY:	unset ListenOnly on a peer by providing it's ip+port, name, or identity
HAVEPEER:	report true/false on having a peer by providing it's ip+port, name, or identity
REMOVEPEER:	remove a peer by providing it's ip+port, name, or identity
PEER:	report the noderef of a peer (without metadata) by providing it's ip+port, name, or identity
PEERWMD:	report the noderef of a peer (with metadata) by providing it's ip+port, name, or identity
PEERS	report tab delimited list of peers with name, ip+port, identity, location, status and idle time in seconds
NAME:	change the node's name.
UPDATE	ask the node to self-update if possible.
STATUS	display some status information on the node including its reference and connections.
SHUTDOWN	exit the program
RESTART	restart the program
QUIT	close the socket