Note: This documentation is for the legacy command-line tool odasa.
The final version was released in May 2020. Support for this tool expires in May 2021.

For documentation on the new generation CodeQL CLI, see CodeQL CLI .
In particular, you may find the Notes for legacy QL CLI users useful in planning your migration.

Skip to end of metadata
Go to start of metadata

On this page:


The documentation on this site is maintained using the Atlassian application Confluence.

What is Confluence?

Confluence is a wiki: a system that allows users to work collaboratively on content. Semmle uses Confluence to create the documentation for many of its applications. Unlike many public wikis, this site is maintained internally at Semmle and is read-only to most users.

If you have not used Confluence 6.13 previously, then you may find the Confluence documentation useful.

What is a space?

Spaces are containers for related pages. Pages are grouped into a number of different spaces, for example: pages containing the documentation for a specific release or pages about rules for a specific language. 

When you search for information, the results are displayed for all matching pages in any space in the wiki. You can use the Space drop-down option, shown on the left of the Search results page, to filter the results to show only results for a specific space (for example, Semmle documentation or QL resources). This makes it easier to find the information you need.

Overview of spaces

There are three main categories of space in the wiki:

  1. Help —  each space contains documentation for a specific release of the products, including both application and admin information, for example: Semmle documentation always contains the most up-to-date information.
  2. Rules — each space contains all the default rules for a specific language, for example: Java queries

  3. QL — the space contains some documentation about the QL language but most of this information has moved to:

How do I navigate to a different space?

  1. Navigation sidebar—shown on every page apart from the front page of the wiki. It contains an overview of the contents of the current space and links to other spaces (see below for more about the sidebar).
  2. Spaces menu—displayed at the top of all pages, select Spaces > Space directory to show a list of all spaces and select the space you want.
  3. Show or hide sidebar—click the Expand sidebar/ Collapse sidebar button to show/hide the sidebar. Alternatively, press the square bracket keyboard key ([) to toggle between showing and hiding the sidebar.
  4. Resize sidebar—Click and move the drag handle to make the sidebar larger or smaller.
  5. Search—search across the whole wiki for the information you want (see "Searching the documentation" below for more information).

Using the navigation sidebar

A navigation sidebar is shown on all pages apart from the landing page. The sidebar is useful for browsing the documentation. 

  1. Space logo and name — click on either to display the space home page.

  2. Quick links — includes links to the most popular topics.

  3. In this space — a table showing the contents and page hierarchy of the current space.
    • Click a icon to expand a section
    • Click a icon to collapse a section
    • Click a title to display that page
  4. Current page — the current page is shown as bold text.

Where am I?

Every page contains information showing where you are in the public wiki, for example:

  1. Space logo — each page shows the logo of the current space at the top left corner of the sidebar. The logo for each space indicates the type of information found in that space.  is used for spaces with help and documentation for the latest release of Semmle analysis. Other spaces have language-specific logos, for example: Java spaces use 
  2. Breadcrumb links — shown above the title of every page. This shows which space you are in and where it is in the hierarchy of pages:

    • Click the ... symbol to show the full location
    • Click on any part of the breadcrumbs to display that page
  3. In this space — this area is shown in the navigation sidebar on all pages. The title of the current page is shown in bold text.

Searching for information

All pages contain a search box in the top right corner of the menu bar. This search box helps speed up your searches by providing two different types of search:

Quick search

An interactive mode. Click on the search box and start typing keywords. As you type, a short list of possible matches is displayed (most recently updated first):

  • If you see the information that you want, click on a page title to display that page.
  • If none of the matches looks right, type the full keywords that you want to search for and then press Return to perform a full search.

Full search

A standard search. Click on the search box, type the keywords to search for and press Return.

The results are displayed on a Search results page:

  1. Results — explore the results and click the title of any page that you want to display.
  2. Search box — add extra keywords and press Enter, or click the Help icon to display information about search syntax.
  3. Filter results — the options in the left sidebar can be used to filter the search results. For example, use the Space drop-down to search just one space (for example, Semmle documentation or the C# rules space).

See Confluence Search documentation for more information about searching.

Printing information

There are two ways to print information:

  • Use the print option available in your browser — the results will vary according to the set up of your browser and printer
  • Export to PDF and print the resulting file — it may take a little longer than simply printing from the browser but the results may be more reliable

To export a page to PDF format, to the right of the page title, click and then click Export to PDF. The content of the page is converted into a PDF file which you can download or view using your standard browser options.

  • No labels