Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
O
OBITools3
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 33
    • Issues 33
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 0
    • Merge Requests 0
  • Operations
    • Operations
    • Incidents
  • Analytics
    • Analytics
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
  • OBITools
  • OBITools3
  • Wiki
  • The OBITools3 syntax

The OBITools3 syntax · Changes

Page history
mercier created page: The OBITools3 syntax authored Dec 13, 2019 by Celine Mercier's avatar Celine Mercier
Show whitespace changes
Inline Side-by-side
Showing with 32 additions and 0 deletions
+32 -0
  • The-OBITools3-syntax.md The-OBITools3-syntax.md +32 -0
  • No files found.
The-OBITools3-syntax.md 0 → 100644
View page @ ee5198c5
* Basic syntax:
obi command [options] input_URI output_URI
* A URI (Uniform Resource Identifier) is a simple way to identify the input and output of a command. For a file, it's simply the path to the file. For a view, it can be the path to the view file in the DMS:
path_to_my_dms.obidms/VIEWS/my_view.obiview
Or a simplified version:
path_to_my_dms/my_view
Any hybrid of those 2 works too.
* View names must be unique within a DMS, in other words, views can not be overwritten.
* All tools accept different input and output DMS.
* If the output DMS is not given, the input DMS is used.
* For a taxonomy, both those and their hybrids work:
path_to_my_dms.obidms/TAXONOMY/my_taxonomy
path_to_my_dms/taxonomy/my_taxonomy
* `obi -h` gives a list of all the commands.
* `obi command -h` prints the help of the command.
* `obi --version` prints the version of the OBITools3 installed.
* Autocompletion of commands and views is available (by pressing tab after 'obi')
\ No newline at end of file
Clone repository
  • Installing the OBITools3
  • The OBITools3 data structure
  • The OBITools3 syntax
  • Updating and release notes
  • Wolf tutorial with the OBITools3
  • Home