Sign In/Up first to start using Satori CI
You can continue this tutorial after logging in.
Satori CI GitHub App Installation Guide
- GitHub account
- Administrative access to target repositories
Click the "Install Satori CI App" button on the GitHub Apps page.
Install Satori CI AppChoose the GitHub account or organization where you want to install Satori CI.
- Ensure you have the necessary installation permissions
- Verify you're logged into the correct account
Select repository access options:
- All Repositories: Provide access to every repository
- Specific Repositories: Manually select individual repositories
Review your selections and click the Install button to finalize.
- You can modify app permissions later in GitHub settings
- Recommended: Start with limited repository access
- Confirm the app's access scope before installation
Authorize Satori CI to use Github Authorization Token(Optional)
To increase the limit for hour for scans tasks you can authorize Satori CI to use a custom token:
Authorize Satori to use GithubCheckout our documentation for more details.
Select playbooks to install in your account
These playbooks will be executed with each push you make
If you prefer you can add/remove playbooks from the console with (see step-4 to configure satori-cli):
# To add a global playbooks:
satori repos playbook add satori://secrets/semgrep.yml
# To remove a global playbook
satori repos playbook del satori://secrets/semgrep.ymlConfigure your email to receive notifications
Configure Satori-CLI
Copy and paste these commands into your console:
pip install satori-ci
satori config token
satoriExecute your first test with Satori-CLI
Create a .satori.yml file, inside a folder of your election, with this content:
test:
assertStdoutEqual: "Hello world!\n"
assertReturnCode: 0
execute:
- echo Hello world!Then run your first playbook with:
satori local ./ --report --output
# Or you can run on our servers with:
satori run ./ --report --outputThis is going to to upload your folder (./) and execute a playbooks ".satori.yml" if found. This is useful for running tests on your code.
If you prefer to run the playbook directly without uploading your folder content, use this command:
satori local .satori.yml --report --output
# Or:
satori run ./ --report --outputFor comprehensive details about Satori CI, its features, configuration options, and best practices, please check out our official documentation. Our documentation provides in-depth guides, troubleshooting tips, and advanced configuration instructions to help you make the most of Satori CI in your development workflow.
View Documentation