Quick Start to Install EDGAR® Renderer

Several alternative installation strategies can be followed:

  1. Install a pre-built application.  These are available with embedded Python and require no developer skills.
  2. Install from sources on gitHub. (See Technical Operation)

Once installed there are two strategies for using the EDGAR renderer:

  1. Interactively from its GUI.  (This now includes a local viewer using the same components as the sec.gov website.)
  2. Technical Operation: from command line, as a web service, or polled operation as a daemon service. (See Technical Operation)


Pre-built application


us site eu cn sites
Windows 64:

Download “Win 64 installer”

arelle-win.exe – Downloaded 296933 times – 73.89 MB
macOS App:

Download “macOS”

arelle-macos.dmg – Downloaded 62093 times – 132.67 MB
Linux x86 64: (Ubuntu)

Download “Ubuntu Linux”

arelle-ubuntu.tgz – Downloaded 39435 times – 123.89 MB
  • Download and install.
    • It isn’t necessary to remove old versions first.
    • If you don’t have administrator rights on your computer, install to a directory that you do have rights to (such as under Documents).

User Operation

Interactively from its GUI

Start Arelle (with installed app, from the Windows start menu start Edgar Renderer Windows or click on arelleGUI.exe, or Mac Application Arelle.app start Edgar Renderer Mac).

Check that the EDGAR renderer plugin is installed and enabled: help→manage plugins. manage plugins
If EDGAR Renderer is not shown, press Select→EDGAR Renderer→ok→close).
select Edgar Renderer
Click yes when asked to restart.
allow to restart

If behind a firewall with Microsoft NTLM proxy service (common in large enterprises), also install the internet proxy plugin for NTLM (help→manage plugins→select→Internet NTLM proxy handler→ok→close).
select NTLM proxy plugin
It may be necessary to start your browser and open a public website (such as google) to “prime” NTLM for your user account, before Arelle can access the outside internet.

For validation using EDGAR Filer Manual, Tools→Validation→Select Disclosure System
select disclosure system
Select an EDGAR Filing Manual validation mode, such as Pragmatic, and press ok.
select disclosure system
Enable Disclosure system checks, this menu entry is a checkmark toggle, click so it is enabled.
check menu selection for disclosure system validation

Open an SEC filing, click open file toolbar button and select the instance document or inline html document. After successful loading the local viewer should display the SEC rendering engine results. If it’s an inline html document, click (Source) top menu entry to see the html form with fact information highlighted by ixviewer.
inline ix viewer
Redline markups in the inline document set are now shown with the View menu selection “Workstation Redline Mode”. (These markups are a private communication from filer to SEC personnel, for SEC workstations upon request. They are not disseminated to the public.)

For filer manual validation click validate toolbar button.


Comments are closed.