Command-line options

A FishEye instance can be managed using the fisheyectl script. Before running this script you need to ensure that you have set the JAVA_HOME environment variable, or that java is on the path.

Unix usage:

/<FishEye install directory>/bin/fisheyectl.sh command [options]

Windows usage:

\<FishEye install directory>\bin\fisheyectl.bat command [options]

The command parameter can be one of runstart or stop (see below). You can also find convenience scripts for running each of these commands, such as run.sh or run.bat.

On this page:

run

The run command starts FishEye. This command runs FishEye in the foreground. It does not fork a background process.

start

The start command has the same options as run, but starts FishEye in the background.

Windows: FishEye will be run in a separate cmd.exe window.

Unix: FishEye will be run with nohup and the console output will be redirected to $FISHEYE_INST/var/log/fisheye.out.

Options (for both run and start):

--config path

Load configuration from the file at path. Default is $FISHEYE_INST/config.xml.

--quiet

Do not print anything to the console.

--debug

Print extra information to the debug log.

--debug-perf This option is redundant and is now a synonym for --debug.

 

The following --X prefixed options are currently available, but are typically used only for specific workarounds and edge cases in support scenarios. They may be removed or changed in any future release:

--Xtab-width nchars

Specifies the number of spaces to use to represent a tab character. The default is 8.

--Xdisable-dirtree-empty-checks

When rendering the directory tree on some pages, FishEye calculates if each directory subtree is empty. For massive repositories, this calculation can cause the page to take a long time to render. This option disables the calculation that determines emptiness.

If you start FishEye with this flag, then empty directories will no longer show up as grey (i.e. deleted) and the option to hide them will also disappear.

--Xdisable-content-indexing

Disables the generation of a full-text index for file content. This prevents further indexing, but does not delete any existing full-text indexes. FishEye will not warn you if you specify this option but still try to do a content search. This option is useful if you do not use content search and you are finding FishEye is taking a long time to index your content.

The option is ignored for Git and Mercurial repositories.

--Xno-slurp Disables regular polling for indexing. We recommend that you disable polling for specific repositories in their configuration options, instead.
--Xenable-git-content-hash-resolving-heuristic This was used to speed up indexing by avoiding an exhaustive lookup of file revisions that give a particular content hash in Git repos. Git manifest support in FishEye removed the need to use this option. It does still apply if a manifest upgrade has not completed.
--Xdisable-head-detection Disables branch head detection in DVCS systems (Git and Mercurial).
--Xdisable-tags Disables tag processing in DVCS systems.
--Xlenient-patches FishEye will attempt to process non-standard patches.

 

stop

The stop command stops a running FishEye instance.

Options:

--config path

Load configuration from the file at path. Default is $FISHEYE_INST/config.xml.

fullscan

Usage:

fisheyectl fullscan [options] [repname ...]

The fullscan command requests a full scan of the given repositories, or all repositories if no repository name is given.

NoteThe fullscan command is only supported for CVS repositories.

Options:

--config path

Load configuration from the file at path. Default is $FISHEYE_INST/config.xml.

rescan

Usage:

fisheyectl rescan [options] repname start end

Requests a rescan of the given repository between two specified revision ids.

Note: this operation is not supported by CVS repositories.

Options:

--config path

Load configuration from the file at path. Default is $FISHEYE_INST/config.xml.

reindex

Usage:

fisheyectl reindex [options] [repname ...]

Requests a full reindex of the given repositories, or all repositories if no repository name is given.

Options:

--config path

Load configuration from the file at path. Default is $FISHEYE_INST/config.xml.

scannow

The scannow command requests an incremental scan from the command line.

Usage:

fisheyectl scannow -s [repname ...]

Options:

-s

Run synchronously; i.e. the command will not terminate until the requested indexing operation is complete.

  • You can set the poll period to 'Never' in which case the repo will be viewable from the web UI but the repository will not be polled.
  • Repositories may be polled in the demand using this code:

    fisheyectl.sh scannow [repname ...]

    This will perform a one-time indexing operation.
    Note: scannow can also be used on a repository which has a poll period.

 

backup / restore

FishEye data can be backed up from the admin interface or command line. This page contains the command syntax, options and the required procedure to back up and restore your FishEye instance: Backing up and restoring FishEye data

svnrules

The svnrules tool ships with FishEye 3.0, and later versions. It parses the SVN log and compares that against the SVN symbolic rules configured in FishEye to find commits that are likely to be branch or tag creation changes for which there are no SVN symbolic rule defined. Find the details here: Verifying SVN symbolic rules

Read more

Was this helpful?

Thanks for your feedback!

Why was this unhelpful?

Have a question about this article?

See questions about this article

Powered by Confluence and Scroll Viewport