Return to main table of contents
Cascade provides a command line client called csc. This client
is analogous to the command line clients like svn and
p4 for the underlying repositories that Cascade communicates to.
However, whereas each repository's own dedicated client has a slightly different
set of commands, Cascade's csc client application is the same for
all repository types.
csc does not aim to completely replace these other client
applications. You may still want to make queries directly to the underlying
repository for any number of reasons. Instead, csc aims to supply
the basic "least common denominator" functionality that all repositories
require, plus access to the added functionality that Cascade provides such as
cloning and checkpointing.
Note that there is no Cascade equivalent to commands such as svn
add or svn delete. As a file system driver, CFS
automatically knows when files are being added or deleted; you don't have to
tell it about these files.
Many of these commands apply to the "current" tree. This is determined by
the working directory of the shell you launch the client from. For example, if
you are currently in the /mnt/cfs/tree/svn/trunk directory,
/mnt/cfs/tree would be the current tree.
The first time you set up a mount point for a particular repository, you will be prompted for credentials (username and password). The prompt looks like this:
Need credentials for URL 'svn-http://svn.collab.net/repos/svn':
Username:Some servers allow anonymous access, usually read-only; in this case, simply hitting Enter twice to provide an empty username and empty password will do. Note that you may not be allowed to commit with anonymous credentials, so if you have a real username and password, you should generally use it.
Once you've entered your credentials for a given repository, they will be
remembered in a file under the directory .csc/auth in your home
directory, e.g., ~/.csc/auth on Unix and
C:\Documents and Settings\username\.csc\auth on Windows. Note that
these files, which contain our usernames and passwords, are stored as plain
text. On Unix-based systems like Linux and Macintosh, the .csc
directory will be created with permissions such that other users cannot read it.
On Windows, Cascade assumes is that you have properly secured your home
directory by other means, either by being the only person with access to your
computer or by having set up the correct permissions.
Sometimes Cascade will prompt for credentials for a repository whose name
starts with csc-http://. This is a prompt for your Cascade
Manager credentials.
The cached credentials do not time out. If you change your username or
password, or if you want to use different credentials, you can delete the entire
.csc/auth directory, e.g., rm -rf ~/.csc/auth.
Applies a previously checkpointed changeset to a non-Cascade-based tree, e.g., a Subversion tree. This provides a way to move changes originally developed in Cascade back into other systems.
Usage:
csc apply -svn|-p4|-ab <id>-svn: Apply to a Subversion tree.
-p4: Apply to a Perforce tree.
-ab: Apply to an Alienbrain tree.
<id>: The ID of the checkpointed changeset to apply.
Creates a checkpoint from the current tree and uploads it to Cascade Manager.
Usage:
csc checkpoint
csc checkpoint -svn|-abThe first form checkpoints from the current Cascade tree.
The second form checkpoints from a non-Cascade tree.
-svn: Checkpoint from a Subversion tree.
-ab: Checkpoint from an Alienbrain tree.
Clones a new Cascade tree rooted at <path> at a particular
revision. The tree's revision can be explicitly specified as a number (which
may be a checkpointed changeset, e.g., 5.1 for checkpoint 1
relative to revision 5), or it can be one of two automatically determined
revisions, last_known_good and latest.
The last_known_good revision is the most recent revision where
all tasks have completed and passed. Cloning from last_known_good
ensures that the tree passes some minimum quality bar.
The latest revision is the most recent revision, regardless of
its testing status.
Usage:
csc clone <path> [<revision>|last_known_good|latest]Creates a checkpoint from the current tree and uploads it to Cascade Manager, kicks off all tasks affected by the changes, waits for those tasks to complete, and then commits the change to the repository.
Usage:
csc commitGets or sets the textual description of the changes in the current Cascade tree.
Usage:
csc describe
csc describe <description>The first form prints the current tree's description.
The second form sets the current tree's description to <description>.
Shows what changes have been made to a file in a Cascade tree.
This command relies on an external diff program specified in the
CSC_DIFF configuration variable. CSC_DIFF contains a
template for a command line used to launch that program, where %B
is replaced by the path to the "baseline" file and %Y is replaced
by the path to "your" file. If CSC_DIFF is not set, its default
value is diff -u %B %Y.
The Windows installer for Cascade sets CSC_DIFF to launch the
TortoiseMerge diff program.
Usage:
csc diff <path>Usage:
csc help [<command>]csc help by itself will give you a list of supported commands.
csc help <command> will give you more information about a
specific command.
Creates a checkpoint from the current tree and uploads it to Cascade Manager, then kicks off all tasks affected by the changes.
Usage:
csc launchMerges your changes to a file in a Cascade tree with other people's changes to
the same file. This is often required after running csc update.
This command relies on an external diff program specified in the
CSC_MERGE configuration variable. CSC_MERGE contains
a template for a command line used to launch that program, where %B
is replaced by the path to the "baseline" file, %Y is replaced by
the path to "your" file, %T is replaced by the path to "their"
file, and %O is replaced by the path to the output file. If
CSC_MERGE is not set, its default value is diff3 -m %Y %B %T
>%O.
The Windows installer for Cascade sets CSC_MERGE to launch the
TortoiseMerge diff program.
Usage:
csc merge <path>Gets or sets the mode (text or binary, executable or not, various other flags) of a file in a Cascade tree.
chmod can also be used to set the executable mode of a file on
Unix operating systems. This command provides a portable means of setting the
executable mode for systems that do not have a chmod command. It
also provides a portable means of discovering that a file is a symbolic link on
platforms not supporting symbolic links.
Usage:
csc mode <path>
csc mode <path> text|binary|+executable|-executableThe first form gets the various mode flags of file <path>.
This is a comma-separated list of strings, which may include any of the
following:
directory: The file is a directory
symlink: The file is a symbolic link
text: The file is a text file
binary: The file is a binary file
executable: The file is executable
read_only: The file is read-only
hidden: The file is a special "hidden" fileThe second form sets the mode of file <path>.
text sets it to being text, and binary sets it to
being binary. +executable sets it to being executable, and
-executable sets it to not being executable.
Gets, creates, or updates mount points in a Cascade tree.
Usage:
csc mount
csc mount <path> <URL> <revision>The first form prints all the mount points in the current tree. Each line in the output has three fields: the path to the mount point, the URL of the repository the mount point refers to, and the revision that mount point is set to.
The second form creates a new mount point at <path> or
updates an existing mount point at <path>. If
<path> does not exist, it will be created and pointed at
repository <URL> at revision <revision>.
If it already exists, <URL> is ignored and its revision is
updated to <revision>.
<revision> may be latest, in which case the
mount point's revision is set to the repository's most recent revision.
Using csc clone and csc update is recommended over
setting up mount points manually with csc mount.
Gets or sets the newline mode of a Cascade tree.
Two newline modes are supported: unix and windows.
Only those files marked as text files using csc mode are affected
by newline translation. (By default, newly created files are considered binary.)
In unix mode, when a text file is uploaded as part of a
checkpoint, its newlines are translated from Windows style (CR LF)
to Unix style (LF). No newline translation is performed when files
are downloaded.
In windows mode, when a text file is downloaded, its newlines
are translated from Unix style (LF) to Windows style (CR
LF). When it is uploaded, they are translated from Windows style
(CR LF) to Unix style (LF).
Usage:
csc newline
csc newline <mode>The first form prints the newline mode of the current tree.
The second form sets the newline mode of the current tree.
Backs out unwanted changes to a Cascade tree.
Usage:
csc revert <path> [<path2> ...]This command reverts one or more edited files <path>,
<path2>, etc. back to their original state in the repository.
If <path> is a directory, the revert is recursive, applying
to all files and subdirectories underneath <path> as well.
Shows what files and directories have been modified in the current Cascade tree, including information on which ones the user needs to merge to make the tree consistent.
If a path is specified, only changes under that path are listed.
Usage:
csc status [<path>]Updates the current (previously cloned) Cascade tree to a new revision. The
revision can be explicitly specified as a number, or it can be one of two
automatically determined revisions, last_known_good and
latest. The meaning of these revisions is the same as the meaning
used by the clone command.
This command can only be used on trees created via csc clone.
It does not support trees created manually via csc mount. If you
want to update a tree created via csc mount, you can reissue the
csc mount command with a new revision number.
Usage:
csc update <revision>|last_known_good|latestComments or questions about the manual? Please email info@conifersystems.com with your feedback.
Copyright © 2008 Conifer Systems LLC. All rights reserved.
Cascade contains valuable trade secrets and other confidential information belonging to Conifer Systems LLC. This software and its associated documentation may not be copied, duplicated or disclosed to third parties without the express written permission of Conifer Systems LLC.