Command Line Operation#
Running Arelle on the Command Line:#
Method or System |
Command |
---|---|
Python source code |
python arelleCmdLine.py arguments |
Windows x64 or 32 bit |
“c:\Program Files\arelleCmdLine.exe” arguments |
MacOS App |
/Applications/Arelle.app/contents/MacOS/arelleCmdLine arguments |
Linux/Unix |
./arelleCmdLine arguments |
Arguments#
General Arguments#
Flag |
Description |
---|---|
-a or --about |
Prints build, copyright, and license information then exits |
-h or --help |
Prints help message and exits |
--diagnostics |
Prints diagnostic information |
--version |
Prints Arelle’s version number and exits |
Input File Arguments#
Flag |
Description |
---|---|
-f |
The |
--username |
The |
--password |
The |
-i |
Imports a |
-d |
Compares a second DTS for versioning report generation. |
-r |
Saves the versioning report (with the diff flag) to the specified |
Validation Arguments#
Flag |
Description |
---|---|
-v or --validate |
Validate the file according to the entry file type. |
--noValidateTestcaseSchema or |
Validate testcases against their schemas. |
--calc= |
Specify calculations validations: |
--calcDecimals or |
DEPRECATED - XBRL v2.1 calculation linkbase validation inferring decimals. |
--calcPrecision or |
DEPRECATED - pre-2010 XBRL v2.1 calculation linkbase validation inferring precision. |
--calcDeduplicate or |
DEPRECATED - de-duplication of consistent facts when performing calculation validation, chooses most accurate fact. |
--efm |
Select Edgar Filer Manual (U.S. SEC) disclosure system validation (strict). |
--efm-skip-calc-tree |
Skip walking of calculation tree during EFM validation. |
--disclosureSystem= |
Specify a |
--hmrc |
Select U.K. HMRC disclosure system validation. |
--utr |
Select validation with respect to Unit Type Registry. |
--utrUrl= |
Used with --utr flag. Override disclosure systems Unit Type Registry. |
--infoset |
Select validation with respect testcase infosets. |
Output Arguments#
These arguments can override the system language settings for the output options below.
Flag |
Description |
---|---|
--labelLang= |
provides an xml:lang language code to override the system language settings for labels output by the following file options, e.g., --labelLang=en-US |
--disableRtl |
Disable reversing string read order for right to left languages, useful for some locale settings |
--labelRole= |
overrides the standard XBRL 2.1 label role for the labels output by the following file options. |
The following file options determine the type of file saved by the extension of the file name, the extension may be any of: “.html”, “.htm”, “.xhtml”, “.json” or “.csv”
Flag |
Description |
---|---|
--DTS= |
Write DTS tree into |
--facts= |
Write fact list into |
--factListCols= |
Columns for fact list file. |
--factTable= |
Write fact table into |
--factListCols= |
Columns for fact list file |
--factTable= |
Write fact table into FILE |
--factTableCols= |
Columns for fact table file |
--concepts= |
Write concepts into |
--pre= |
Write presentation linkbase into |
--table= |
Write table linkbase into |
--cal= |
Write calculation linkbase into |
--dim= |
Write dimensions (of definitions) into |
--anch= |
Write anchoring relationships (of definition) linkbase into |
--formulae= |
Write formulae linkbase into |
--viewArcrole= |
Store relationships for the |
--viewFile= |
Specifies the file to store the --viewArcrole relationships. |
--roleTypes= |
Store defined role types in specified |
--arcroleTypes= |
Store defined arcrole types in specified |
--testReport= |
Write a test report of validation (of test cases) in specified |
--testReportCols= |
Used with --testReport argument. Specifies columns for test report. |
--rssReport= |
Write a test report of RSS feed processing in specified |
--rssReportCols= |
Used with --rssReport argument. Specifies columns for RSS processing. |
Logging Arguments#
Flag |
Description |
---|---|
--logFile= |
Write log messages into |
--logFormat= |
Specify the Python logger |
--logLevel= |
Minimum |
--logLevelFilter= |
Regular expression filter for logLevel. (E.g., to not match -semantic levels, --logLevelFilter=(?!^.-semantic$)(.+). |
--collectProfileStats |
Collect profile statistics, such as timing of validation activities and formulae. |
Validation and Formula Options#
Flag |
Description |
---|---|
--parameters |
Specifies parameters for formula and validation (name=value[,name=value]). |
--parameterSeparator |
Used with --parameters argument. Specify parameters separator string (if other than comma, may be a multi-character separator). |
--formula |
Specify formula action, If this option is not specified, -v or --validate will validate and run formulas if present: |
--formulaParamExprResult |
Enable ParamExprResult formula tracing. |
--formulaParamInputValue |
Enable ParamInputValue formula tracing. |
--formulaCallExprSource |
Enable CallExprSource formula tracing. |
--formulaCallExprCode |
Enable CallExprCode formula tracing. |
--formulaCallExprEval |
Enable CallExprEval formula tracing. |
--formulaCallExprResult |
Enable CallExprResult formula tracing. |
--formulaVarSetExprEval |
Enable VarSetExprEval formula tracing. |
--formulaVarSetExprResult |
Enable VarSetExprResult formula tracing. |
--formulaVarSetTiming |
Show times of variable set evaluation |
--formulaAsserResultCounts |
Enable AsserResultCounts formula tracing. |
--formulaFormulaRules |
Enable FormulaRules formula tracing. |
--formulaVarsOrder |
Enable VarsOrder formula tracing. |
--formulaVarExpressionSource |
Enable VarExpressionSource formula tracing. |
--formulaVarExpressionCode |
Enable VarExpressionCode formula tracing. |
--formulaVarExpressionEvaluation |
Enable VarExpressionEvaluation formula tracing. |
--formulaVarExpressionResult |
Enable VarExpressionResult formula tracing. |
--formulaVarFiltersResult |
Enable VarFiltersResult formula tracing. |
--formulaVarFiltersWinnowing |
Show winnowing process of successive application of formulas, helpful in debugging to find out which filter affects the facts that pass a filtering step |
--formulaVarFiltersResult |
Show result of filters. |
Configuration options#
It is possible to specify options to be defaults for the web server, such as disclosureSystem and validations, but not including file names.
Flag |
Description |
---|---|
--uiLang |
Language for user interface (override system settings, such as program messages). |
--proxy |
Modify and re-save proxy settings configuration. Enter system to use system proxy setting, none to use no proxy, a specific proxy in the format http://[user[:password]@]host[:port] |
--internetConnectivity |
Specify internet connectivity: online or offline. |
--internetTimeout |
Specify internet connection timeout in seconds (0 means unlimited). |
--internetRecheck |
Specify frequency of rechecking web file’s time stamps to cached file copy and determine if newer file to be reloaded: weekly (default), daily or never. |
--noCertificateCheck |
Skip https SSL certificate checking. |
--internetLogDownloads |
Log an info message for downloads to the web cache. |
--xdgConfigHome |
Specify non-standard location for configuration and cache files (overrides environment parameter XDG_CONFIG_HOME, if also provided). |
--plugin[s] |
Specify plugins to load (no longer saved or shared with GUI) |
--packages |
Modify taxonomy packages configuration. (not saved or shared with GUI) |
--abortOnMajorError |
Abort process on major error, such as when load is unable to find an entry or discovered file. |
--webserver |
Start web server on host:port[:server] for REST and web access. |
Standard Plugins and Options#
Many of the plug-ins add command line (in addition to GUI menu) options.
For additional detail see the plug-in documentation. A summary of standard plugin options is provided here.
inlineDocumentSet |
Specify an inline XBRL document set by JSON parameter: --file ‘[{“ixDocumentSet”:[{“file”:file1},{“file”:file2}…]}]’ |
---|---|
--save-instance |
Provides a file name into which to save an XBRL instance document derived from a loaded manifest (Japan FSA) of a document set of inline documents, or loaded single inline document. |
loadFromExcel |
Load from Excel file |
---|---|
No command line options, but the -f and --file options can specify an Excel document which represents a DTS. |
profileCmdLine |
Profiles command line operation |
---|---|
--save-profiler-report |
Specifies file into which to save a Python profiler report of the timings of Arelle Python methods and routines for the operations performed by the other command line functions. |
saveDTS |
Produces TaxonomyPackage. |
---|---|
--package-DTS |
Specifies a file into which to save a Taxonomy Package representing the loaded DTS. |
saveHtmlEBAtables |
EBA Table Sets. |
---|---|
--save-EBA-tablesets |
Specifies an index file (usually index.html) to represent an html page that holds a table of contents to the EBA tables generated for all loaded EBA Table Linkbase tables in the DTS. |
saveLoadableExcel |
Saves an Excel workbook |
---|---|
--save-loadable-excel |
Saves an Excel workbook representing the DTS (which can be subsequently loaded by loadFromExcel.py plugin. |
saveSKOS |
Saves a SKOS (OMG standard OWL file). |
---|---|
--save-skos |
Saves a SKOS (OMG standard OWL file) representing a semantic view of a DTS based on presentation linkbase entries (for US-GAAP, IFRS, and EDInet style taxonomies). |
xbrlDB |
Saves XBRL data to a database. |
---|---|
--store-to-XBRL-DB |
Store into XBRL DB. Provides connection string: host,[port], user, password, database, [timeout], technology. |
postgres - XBRL-US Postgres SQL |
|
For rdfDB if hostname is rdfTurtleFile or rdfXmlFile, then database specifies a local file system pathname to store a file. |
|
Example storing into postgres database using XBRL-US schema |
arelleCmdLine -f c:\temp\test.rss -v --disclosureSystem efm-pragmatic-all-years --store-to-XBRL-DB “myhost.com,8084,pgUserId,pgPassword,test_db,90,postgres” |
Example storing into local MSSQL database using SQLEXPRESS instance |
arelleCmdLine -f c:\temp\test.rss -v --disclosureSystem efm-pragmatic-all-years --store-to-XBRL-DB “localhost\SQLEXPRESS,,sqlLogin,sqlPassword,,90,mssqlSemantic” |
Disclosure System Selections#
Run with --disclosureSystem=help
to list the disclosure systems that are available for the currently loaded plugins.