FreenetWiki: Freenet Text Mode Client Interface (TMCI)

Most recent edit on 2006-07-13 23:21:51 by JaQa

Additions:
<td valign="top">PUTSSK:insert_uri;redirect_url</td>
<td valign="top">PUTSSKDIR:insert_uri#path

PUTSSKDIR:insert_uri#path#defaultfile</td>

<td valign="top">Insert an entire directory to an SSK. Optionally include a default file.</td>
<td valign="top">PLUGLOAD:</td>
<td valign="top">Load plugin. (use "PLUGLOAD:?" for more info)</td>

Deletions:
<td valign="top">PUTSSK:insert_uri;redirect_url</td>
<td valign="top">PUTSSKDIR:<insert uri>#<path>[#<defaultfile>]
<td valign="top">Insert an entire directory to an SSK.
<td valign="top">PLUGLOAD:
<td valign="top">Load plugin. (use "PLUGLOAD:?" for more info)

Edited on 2006-07-13 23:19:36 by JaQa

Additions:
<table border="1" cellpadding="4" cellspacing="2">
<td valign="top">Insert an entire directory to Freenet from disk. Optionally include a default filename</td>
<td valign="top">GETCHKDIR:path

GETCHKDIR:path#defaultfile</td>

<td valign="top">Get the key that would be returned if we'd put the entire directory from disk.<td>
<td valign="top">MAKESSK</td>
<td valign="top">Create an SSK keypair.</td>
<td valign="top">PUTSSK:insert_uri;redirect_url</td>
<td valign="top">Insert an SSK redirect to a file already inserted.</td>

Deletions:
<table cellpadding="4" cellspacing="2">
<td valign="top">Put the entire directory from disk. Optionally include a default filename</td>
<td valign="top">GETCHKDIR:<path>[#<defaultfile>]
<td valign="top">Get the key that would be returned if we'd put the entire directory from disk.
<td valign="top">MAKESSK
<td valign="top">Create an SSK keypair.
<td valign="top">PUTSSK:<insert uri>;<url to redirect to>
<td valign="top">Insert an SSK redirect to a file already inserted.

Edited on 2006-07-13 22:43:20 by JaQa

Additions:
<td valign="top">GET:freenet_key</td>
<td valign="top">Fetch a file from Freenet with the given key. The contents of the file are echoed to the console.</td>
<td valign="top">GETFILE:freenet_key</td>
<td valign="top">Get the CHK key that would be returned if we inserted the file to Freenet, but don't actually do the insert.</td>
<td valign="top">PUTDIR:path

PUTDIR:path#defaultfile</td>

<td valign="top">Put the entire directory from disk. Optionally include a default filename</td>

Deletions:
<td valign="top">GET:Freenet key</td>
<td valign="top">Fetch a file from Freenet with the give key.</td>
<td valign="top">GETFILE:filename</td>
<td valign="top">Get the key that would be returned if we inserted the file.</td>
<td valign="top">PUTDIR:<path>[#<defaultfile>]
<td valign="top">Put the entire directory from disk.

Edited on 2006-07-13 22:34:21 by JaQa

Additions:
<td valign="top">PUTFILE:filename

PUTFILE:filename#mimetype</td>

<td valign="top">GETFILE:filename</td>
<td valign="top">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.</td>
<td valign="top">GETCHKFILE:filename</td>
<td valign="top">Get the key that would be returned if we inserted the file.</td>

Deletions:
<td valign="top">PUTFILE:filename[#mimetype]</td>
<td valign="top">GETFILE:<filename>
<td valign="top">Fetch a key and put it in a file. If the key includes a filename we will use it but we will not overwrite local files.
<td valign="top">GETCHKFILE:<filename>
<td valign="top">Get the key that would be returned if we inserted the file.

Edited on 2006-07-13 22:31:05 by JaQa

Additions:
<td valign="top">Use the single line of text as a file to insert to Freenet, and return the key used.</td>
<td valign="top">Get the key that would be used if the file was inserted to Freenet, but dont actually insert the file.</td>
<td valign="top">GETCHK:A single line of text</td>
<td valign="top">Get the CHK key that would be returned if the line was inserted to Freenet, but don't actually do the insert.</td>
<td valign="top">PUTFILE:filename[#mimetype]</td>
<td valign="top">Insert to Freenet the file with full path called filename. Optionally include the MIME type of the file, for example text/html.</td>

Deletions:
<td valign="top">Use the single line of text as a file to insert, and return the key used.</td>
<td valign="top">Get the key that would be used if the file was inserted, but dont actually insert the file.</td>
<td valign="top">GETCHK:<text>
<td valign="top">Get the key that would be returned if the line was inserted.
<td valign="top">PUTFILE:<filename>[#<mimetype>]
<td valign="top">Put a file from disk.

Edited on 2006-07-13 22:27:36 by JaQa

Additions:
<td valign="top">GET:Freenet key</td>
<td valign="top">Fetch a file from Freenet with the give key.</td>
<td valign="top">PUT: Multiple lines of text, like this, ended by a . on a line by itself .</td>
<td valign="top">Insert the file into Freenet and return the key that was used.</td>
<td valign="top">PUT:A single line of text</td>
<td valign="top">Use the single line of text as a file to insert, and return the key used.</td>
<td valign="top">GETCHK: Multiple lines of text, like this, ended by a . on a line by itself .</td>
<td valign="top">Get the key that would be used if the file was inserted, but dont actually insert the file.</td>

Deletions:
<td valign="top">GET:<Freenet key></td>
<td valign="top">Fetch a key</td>
<td valign="top">PUT:\r\n<text, until a . on a line by itself>
<td valign="top">Insert the document and return the key.
<td valign="top">PUT:<text>
<td valign="top">Put a single line of text to a CHK and return the key.
<td valign="top">GETCHK:\r\n<text, until a . on a line by itself>
<td valign="top">Get the key that would be returned if the document was inserted.

Edited on 2006-07-13 22:21:43 by JaQa

Additions:
<table cellpadding="4" cellspacing="2">

Deletions:
<table>

Edited on 2006-07-13 22:21:03 by JaQa

Additions:
<td valign="top">PUT:\r\n<text, until a . on a line by itself>
<td valign="top">Insert the document and return the key.
<td valign="top">PUT:<text>
<td valign="top">Put a single line of text to a CHK and return the key.
<td valign="top">GETCHK:\r\n<text, until a . on a line by itself>
<td valign="top">Get the key that would be returned if the document was inserted.
<td valign="top">GETCHK:<text>
<td valign="top">Get the key that would be returned if the line was inserted.
<td valign="top">PUTFILE:<filename>[#<mimetype>]
<td valign="top">Put a file from disk.
<td valign="top">GETFILE:<filename>
<td valign="top">Fetch a key and put it in a file. If the key includes a filename we will use it but we will not overwrite local files.
<td valign="top">GETCHKFILE:<filename>
<td valign="top">Get the key that would be returned if we inserted the file.
<td valign="top">PUTDIR:<path>[#<defaultfile>]
<td valign="top">Put the entire directory from disk.
<td valign="top">GETCHKDIR:<path>[#<defaultfile>]
<td valign="top">Get the key that would be returned if we'd put the entire directory from disk.
<td valign="top">MAKESSK
<td valign="top">Create an SSK keypair.
<td valign="top">PUTSSK:<insert uri>;<url to redirect to>
<td valign="top">Insert an SSK redirect to a file already inserted.
<td valign="top">PUTSSKDIR:<insert uri>#<path>[#<defaultfile>]
<td valign="top">Insert an entire directory to an SSK.
<td valign="top">PLUGLOAD:
<td valign="top">Load plugin. (use "PLUGLOAD:?" for more info)
<td valign="top">PLUGLIST
<td valign="top">List all loaded plugins.
<td valign="top">PLUGKILL:<pluginID>
<td valign="top">Unload the plugin with the given ID (see PLUGLIST).
<td valign="top">CONNECT:<filename|URL>
<td valign="top">see ADDPEER:<filename|URL> below
<td valign="top">CONNECT:\r\n<noderef>
<td valign="top">see ADDPEER:\r\n<noderef> below
<td valign="top">DISCONNECT:<ip:port|name>
<td valign="top">see REMOVEPEER:<ip:port|name|identity> below
<td valign="top">ADDPEER:<filename|URL>
<td valign="top">add a peer from its ref in a file/url.
<td valign="top">ADDPEER:\r\n<noderef including an End on a line by itself>
<td valign="top">add a peer by entering a noderef directly.
<td valign="top">DISABLEPEER:<ip:port|name|identity>
<td valign="top">disable a peer by providing it's ip+port, name, or identity
<td valign="top">ENABLEPEER:<ip:port|name|identity>
<td valign="top">enable a peer by providing it's ip+port, name, or identity
<td valign="top">SETPEERLISTENONLY:<ip:port|name|identity>
<td valign="top">set ListenOnly on a peer by providing it's ip+port, name, or identity
<td valign="top">UNSETPEERLISTENONLY:<ip:port|name|identity>
<td valign="top">unset ListenOnly on a peer by providing it's ip+port, name, or identity
<td valign="top">HAVEPEER:<ip:port|name|identity>
<td valign="top">report true/false on having a peer by providing it's ip+port, name, or identity
<td valign="top">REMOVEPEER:<ip:port|name|identity>
<td valign="top">remove a peer by providing it's ip+port, name, or identity
<td valign="top">PEER:<ip:port|name|identity>
<td valign="top">report the noderef of a peer (without metadata) by providing it's ip+port, name, or identity
<td valign="top">PEERWMD:<ip:port|name|identity>
<td valign="top">report the noderef of a peer (with metadata) by providing it's ip+port, name, or identity
<td valign="top">PEERS
<td valign="top">report tab delimited list of peers with name, ip+port, identity, location, status and idle time in seconds
<td valign="top">NAME:<new node name>
<td valign="top">change the node's name.
<td valign="top">UPDATE
<td valign="top">ask the node to self-update if possible.
<td valign="top">STATUS
<td valign="top">display some status information on the node including its reference and connections.
<td valign="top">SHUTDOWN
<td valign="top">exit the program
<td valign="top">RESTART
<td valign="top">restart the program
<td valign="top">QUIT
<td valign="top">close the socket

Deletions:
PUT:\r\n<text, until a . on a line by itself>
Insert the document and return the key.
PUT:<text>
Put a single line of text to a CHK and return the key.
GETCHK:\r\n<text, until a . on a line by itself>
Get the key that would be returned if the document was inserted.
GETCHK:<text>
Get the key that would be returned if the line was inserted.
PUTFILE:<filename>[#<mimetype>]
Put a file from disk.
GETFILE:<filename>
Fetch a key and put it in a file. If the key includes a filename we will use it but we will not overwrite local files.
GETCHKFILE:<filename>
Get the key that would be returned if we inserted the file.
PUTDIR:<path>[#<defaultfile>]
Put the entire directory from disk.
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>;<url to redirect to>
Insert an SSK redirect to a file already inserted.
PUTSSKDIR:<insert uri>#<path>[#<defaultfile>]
Insert an entire directory to an SSK.
PLUGLOAD:
Load plugin. (use "PLUGLOAD:?" for more info)
PLUGLIST
List all loaded plugins.
PLUGKILL:<pluginID>
Unload the plugin with the given ID (see PLUGLIST).
CONNECT:<filename|URL>
see ADDPEER:<filename|URL> below
CONNECT:\r\n<noderef>
see ADDPEER:\r\n<noderef> below
DISCONNECT:<ip:port|name>
see REMOVEPEER:<ip:port|name|identity> below
ADDPEER:<filename|URL>
add a peer from its ref in a file/url.
ADDPEER:\r\n<noderef including an End on a line by itself>
add a peer by entering a noderef directly.
DISABLEPEER:<ip:port|name|identity>
disable a peer by providing it's ip+port, name, or identity
ENABLEPEER:<ip:port|name|identity>
enable a peer by providing it's ip+port, name, or identity
SETPEERLISTENONLY:<ip:port|name|identity>
set ListenOnly on a peer by providing it's ip+port, name, or identity
UNSETPEERLISTENONLY:<ip:port|name|identity>
unset ListenOnly on a peer by providing it's ip+port, name, or identity
HAVEPEER:<ip:port|name|identity>
report true/false on having a peer by providing it's ip+port, name, or identity
REMOVEPEER:<ip:port|name|identity>
remove a peer by providing it's ip+port, name, or identity
PEER:<ip:port|name|identity>
report the noderef of a peer (without metadata) by providing it's ip+port, name, or identity
PEERWMD:<ip:port|name|identity>
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:<new node 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

Edited on 2006-07-13 22:19:38 by JaQa

No differences.

Edited on 2006-07-13 22:18:53 by JaQa

Additions:
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.
This is followed by a brief list of commands.

TMCI commands

PUT:\r\n Insert the document and return the key. PUT: Put a single line of text to a CHK and return the key. GETCHK:\r\n Get the key that would be returned if the document was inserted. GETCHK: Get the key that would be returned if the line was inserted. PUTFILE:[#] Put a file from disk. GETFILE: Fetch a key and put it in a file. If the key includes a filename we will use it but we will not overwrite local files. GETCHKFILE: Get the key that would be returned if we inserted the file. PUTDIR:[#] Put the entire directory from disk. GETCHKDIR:[#] Get the key that would be returned if we'd put the entire directory from disk. MAKESSK Create an SSK keypair. PUTSSK:; Insert an SSK redirect to a file already inserted. PUTSSKDIR:#[#] Insert an entire directory to an SSK. 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

Command	Description
GET:	Fetch a key

Deletions:
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.

Edited on 2006-07-13 22:14:26 by JaQa

Additions:
You should get back a response that starts something like this:
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
Trivial Text Mode Client Interface

Freenet 0.7 Build #878 r9593
Enter one of the following commands:

Edited on 2006-07-13 22:13:39 by JaQa

Additions:
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:

telnet localhost 2323

Oldest known version of this page was edited on 2006-07-13 22:09:59 by JaQa []

Page view:

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.

FreenetWiki : FreenetTMCI

TMCI commands

Freenet Text Mode Client Interface (TMCI)