Documentation/CLI
From Soar Wiki
Active Command Set
The following is a list of all Soar commands, in alphabetical order. Use -h or --help as the first argument of a command to get online help for the command. Alternatively, type help command.
- add-wme
- Manually add an element to working memory.
- alias
- Define a new command using existing commands and arguments.
- attribute-preferences-mode
- For Soar 7, this command sets and prints the attributes preferences mode to control the handling of preferences (other than acceptable and reject preferences) for non-context slots.
- capture-input
- Capture input for replay.
- cd
- Change directory.
- chunk-name-format
- Specify format of the name to use for new chunks.
- clog
- Record all user-interface input and output to a file.
- command-to-file
- Dump the printed output and results of a command to a file.
- default-wme-depth
- Set the level of detail used to print WMEs.
- dirs
- List the directory stack (see pushd/popd).
- echo
- Print a string to the current output device (output-strings-destination).
- echo-commands
- Set whether or not commands are echoed to other connected debuggers.
- edit-production
- Fire the edit production event.
- excise
- Delete Soar productions from production memory.
- explain-backtraces
- Print information about chunk and justification backtraces.
- firing-counts
- Print the number of times each production has fired.
- gds-print
- Print the WMEs in the goal dependency set for each goal.
- gp
- Generate productions according to a specified pattern.
- help
- Provide formatted, on-line information about Soar commands.
- indifferent-selection
- Controls indifferent preference arbitration.
- init-soar
- Reinitialize Soar so a program can be rerun from scratch.
- input-period
- For Soar7-mode, controls the rate of input to the Soar agent.
- internal-symbols
- Print information about the Soar symbol table.
- learn
- Set the parameters for chunking, Soar's learning mechanism.
- load-library
- Load a shared library into the local client (for the purpose of, e.g., providing custom event handling).
- ls
- List the contents of the current working directory.
- matches
- Print information about the match set and partial matches.
- max-chunks
- Limit the number of chunks created during a decision cycle.
- max-elaborations
- Limit the maximum number of elaboration cycles in a given phase.
- max-memory-usage
- Set the amount of bytes necessary to trigger the memory usage exceeded event.
- max-nil-output-cycles
- Limit the maximum number of decision cycles executed without producing output.
- memories
- Print memory usage for production matches.
- multi-attributes
- Declare multi-attributes so as to increase Rete matching efficiency.
- numeric-indifferent-mode
- Select method for combining numeric preferences.
- o-support-mode
- Choose experimental variations of o-support.
- popd
- Pop a directory off of the directory stack, changing to it.
- predict
- Predict the next selected operator
- preferences
- Examine items in preference memory.
- Print items in working memory or production memory.
- production-find
- Find productions that contain a given pattern.
- pushd
- Push a directory onto the directory stack, changing to it.
- pwatch
- Trace firings and retractions of specific productions.
- pwd
- Print the current working directory.
- quit
- Close log file, terminate Soar, and return user to the operating system.
- rand
- Generate a random number.
- remove-wme
- Manually remove an element from working memory. (Needs gSKI code support.)
- replay-input
- Replay input from file.
- rete-net
- Save the current Rete net, or restore a previous one.
- rl
- Get/Set Soar-RL parameters and statistics
- run
- Begin Soar's execution cycle.
- save-backtraces
- Save trace information to explain chunks and justifications.
- select
- Force the next selected operator
- set-library-location
- Set the top level directory containing demos/help/etc.
- set-stop-phase
- Controls the phase where agents stop when running by decision.
- soar8
- Toggle between Soar 8 methodology and Soar 7 methodology.
- soarnews
- About Soar.
- source
- Load and evaluate the contents of a file.
- sp
- Create a production and add it to production memory.
- srand
- Seed the random number generator.
- stats
- Print information on Soar’s runtime statistics.
- stop-soar
- Interrupt a running Soar program.
- time
- Use the system clock to record the time required to execute the next command.
- timers
- toggle on or off the internal timers used to profile Soar.
- unalias
- Deactivate an alias.
- verbose
- Control detailed information printed as Soar runs.
- version
- Print the version information for the Soar kernel.
- waitsnc
- Generate a wait state rather than a state-no-change impasse.
- warnings
- Toggle whether or not warnings are printed.
- watch
- Control the information printed as Soar runs.
- watch-wmes
- Print information about wmes that match a certain pattern as they are added and removed.
Default Aliases
Obsolete Commands
- attention-lapse
- Enable/disable the attentional lapsing capabilities of Soar.
- format-watch
- Format the trace output that’s printed as Soar runs.
- home
- Change startup directory.
- io
- Register or cancel routines for managing Soar’s input and output links.
- monitor
- Manage attachment of Tcl scripts to Soar events.
- output-strings-destination
- Redirect the Soar output stream. (goes away?) Replaced by print callback support.
- start-attention-lapse
- Sets the amount of real time that should pass before ending the
- wake-from-attention-lapse
- primarily intended to be called from the RHS of a production rule. This sets the "attention-lapsing" variable to FALSE (0), and starts tracking the amount of real time that has passed since the last lapse.
