sTeam Command Line

#COMMANDS

• list:

List Gates/Exits, Documents, Containers, Groups.

list <object>

• goto:

Goto a Room using a full path to the Room.

goto <fullpath to room>

• title:

Set the description of the current user.

title <description to be set>

• room:

Describe the Room you are currently in.

• look:

Look around the Room. List out the Documents, Containers, Gates and Rooms in the current room

• take:

Copy a object in your inventory. It adds the object to your rucksack which can be looked into using command inventory or i.

take <object>

• gothrough:

Go through a gate or an exit.

gothrough <gate/exit>

• create:

Create an object (File/Container/Exit/Group). Provide the full path of the destination or a . if you want it in current folder.

create <object> <name of the object> <location of object. '.' for current room>

• peek:

Peek through a container to see the containers and files inside it.

peek <container>

• inventory:

List your inventory, that is, the content of your rucksack.

• edit:

Edit files in the current Room.

edit <filename1> <filename2> ...

• join:

Join a group.

join <group_name>

• leave:

Leave a group.

leave <group_name>

#FAQ

• Why do we need command line for sTeam?

  To access the server while it is running, inspect the data it has stored and make adhoc changes.

• What utilities does sTeam command line provide to the user?

  It primarily provides proxy objects to the same objects in the server.
  Function calls on these objects are sent to the server and the result is sent back.

• What dependencies do we need to execute the sTeam command line?

  The COAL protocol implementation is needed, which is part of the server code.

• How to access the sTeam command line?

  run ./debug.pike in the tools directory (/usr/local/lib/steam/tools) of the server installation.

• How to execute commands in the sTeam command line?

  Start with getting an object:

    me;  
    OBJ("/home/steam");  
    GROUP("steam");  
    USER("root");  
  

  Then call functions on that object.

• What are the different commands which can be executed on the command line?

  Any function that the object supports.
  Check the source sTeam classes in /server/classes/
  In addition there are special function only available in the client, such as "create();", which allow you to create new objects.
  Common function would be to "list Rooms;" , "List Gates;".

• How to use edit.pike?

  Run ./edit.pike Path to the created object. For eg. if a txt file is made with the address /home/steam/foobar.txt

 ./edit.pike /home/steam.foobar.txt

• What errors can user face while running sTeam in command line mode?

  If you run a function that takes to many server resources, the connection drops.

• What new features can be implemented in sTeam command line?

  See the Idea's page