Command Line Description¶

Scanning¶

Start from scratch¶

You would like to start from scratch with SupoSE.

supose scan --url URLRepository --create --index index.Test

• --url URLRepository
  • This will define the URL^(2)^ where your repository is accessible.
• --create
  • Create a new index.
• --index index.Test
  • Define the directory where to store the created index. In this
    case this is an relative path. This means it will be created
    at the current position. You can define of course an absolute
    path if you need to.
• You have not defined an start- or end revision on the command line so this means the scanning will get all revisions from Revision 1 till HEAD.

Scan only parts of a repository¶

• You would like to start from scratch with SupoSE but wouldn't scan
  the whole contents of the repository.

supose scan --url URLRepository --create --index index.Test --torev 500

• The only difference to the above example is, that we defined the --torev option to stop the scanning at revision 500 but we start from revision 1.

* The second time you call the scanner you have to be a little bit careful about the *--create* option. This option should be
given only once, cause it will destroy any previously existing index.

supose scan --url URLRepository --fromrev 501 --index index.Test

Searching¶

Searching is more or less simple to define. You just give the index you like to use and the query you have.

 supose search --index index.Test --query "QUERY" 

If you like to define which fields will be printed out in the result you have to use the *--fields* option. Their you can give different field names to define that they should be printed out. So the following command will search in the index with the given query and will print out the fields revision and message.

 supose search --index index.Test --fields revision message --query "QUERY" 

Scheduling¶

You can schedule the scanning process if you like to get rid of the hand scanning (or may be you thought about) cron based scanning of the repositories. The more comfortable way will be to let SupoSE do the work for you.

Command line parameters are

• configuration - Define where to find the ini file with the information about the different repositories. This is required.
• configbase - Define where to put the created index files etc. This is required.

supose schedule --configuration ./repositories.ini --configbase ./

This will start program which will read the configuration from the given repository.ini file and start a cron based program which will be running till you kill it by using CTRL-C on command line or the real kill command (Task Manager on Windows or kill on Unix command line).

Merging¶

If you got multiple index files and want to merge them into one, you've got to enter something like the following

supose merge --destination ./mergedindexfolder --index ./firstindexfolder ./secondindexfolder ./thirdindexfolder

Help¶

If you would like to see what command line options are also possible, just type

supose --help

_{(1) For all examples you have to be aware to append ".sh" or ".cmd" for the appropiate platform you are working on. For Linx/Unix you have to append ".sh" and for Windows you have to append ".cmd".}

_{(2) I suggest you to use file:// protocol for the scanning to get maximum performance, but http:// protocol is working too, but a little slower.}