ChucK/Dev/Shell/doc

From CSWiki
Revision as of 15:23, 2 March 2006 by Art (talk | contribs) (Command Summary)

Jump to: navigation, search

Introduction

The ChucK shell provides a simple, built-in way to add and modify programs on-the-fly and to manage ChucK sessions.

Command Line Options

--shell

Opens ChucK shell and starts the virtual machine.

--empty

Opens a ChucK shell without a virtual machine.

Command Summary

  • shell commands
  • Shred Management
    • add [files] or + [files]
      • adds [files] to current VM and prints out a shred reference number for each file
    • remove [ids] or - [ids]
    • removeall
    • replace id filename [id filename]...
    • -- (remove shred with highest id)
    • status or ^
  • Shell Management
    • ls (like unix ls)
    • alias and unalias (simple substitution-based, bash-like command aliases)
    • shreds list all shreds on the current VM
    • pwd
    • cd (change directory, also change current dir for chuck so paths are consistent)
    • close close down shell, keep process VM running
    • exit exit everything
  • Virtual Machine Management
    • vm attach [hostname[:port]] or vm @ [hostname[:port]] attempts to attach to a ChucK VM running on hostname:port. The default port is 8888. If no hostname or port is specified, the shell attempts to attach to the in-process VM
      • prints a success message and the VM reference number for each successful attachment; prints a failure message for each failed attachment
    • vm + or vm add
      • saves the current VM for later use
    • vm - [vm_reference] or vm remove [vm_reference]
      • removes specified VM--it is no longer on the VM list
    • vm = [vm_reference] or vm swap [vm_reference]
    • vms or vm list
      • lists all VMs plus the current VM
    • vm @+ hostname:port adds and attaches the specified VM
    • kill kills the current vm--shuts down the shell too if current_vm is the process vm

Inline Coding

Tutorial 1

Tutorial 2