Skip to content

Running Fidesctl Locally (Standalone)

This method of running fidesctl requires zero dependencies outside of Python and a default pip installation of fidesctl. It is intended as the fastest possible quick start and is not designed for production-grade deployments.

To run in standalone mode, use one of the following methods:

CLI flag
1
fidesctl --local <subcommand>
fidesctl.toml
1
2
[cli]
local_mode = true

For more information on running a full fidesctl installation, see the Running Fidesctl Locally (Full Installation) or Running Fidesctl in Docker pages.

System Requirements

See the Python section of the Prerequisites and Dependencies page for more information.

Fidesctl Installation

The next step is to install fidesctl via pipx:

1
pipx install fidesctl

For more information on pipx, installing fidesctl, and other potential extras, see the Installation from PyPI guide.

Verifying the Installation

Now that we have fidesctl installed, let's verify the installation:

Command
1
fidesctl --version
Expected Output
1
fidesctl, version 1.0.0

Initializing Fidesctl

With Fidesctl installed, it's time to initialize fidesctl for a project, so we have some place to start adding resource manifests and tweaking our configuration.

Switch to your project's root directory, and initialize fidesctl:

Initialize Fidesctl
1
fidesctl init
Expected Output
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
Initializing Fidesctl...
----------
Created a './.fides' directory.
----------
Created a fidesctl config file: ./.fides/fidesctl.toml
To learn more about configuring fidesctl, see:
    https://ethyca.github.io/fides/installation/configuration/
----------
For example policies and help getting started, see:
    https://ethyca.github.io/fides/guides/policies/
----------
Fidesctl initialization complete.

That's it! Your local standalone installation of fidesctl is up and running.

Next Steps

See the Tutorial page for a step-by-step guide on setting up a Fides data privacy workflow.

Back to top