-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
More updates: codemods, installation, intro
- Loading branch information
Showing
5 changed files
with
44 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,38 +4,46 @@ sidebar_position: 1 | |
|
||
# Introducing Pixeebot 👋 | ||
|
||
Pixeebot is a [GitHub app](https://github.com/apps/pixeebot/) that automatically improves your code. It acts like a developer on your team by reviewing your code, and recommending changes to enhance code quality, performance, and security. Pixeebot opens merge-ready pull requests (PRs) for each recommendation, so all you have to do is review and merge. | ||
Pixeebot is your automated product security engineer. | ||
|
||
Pixeebot is powered by our open source toolkit [codemodder](https://codemodder.io/), a pluggable framework for building expressive codemods. These codemods help power Pixeebot’s recommendations, and are continuously updated to ensure Pixeebot’s recommendations align with industry standards and best practices. | ||
Pixeebot triages and fixes issues detected by your [code scanning tools](/code-scanning-tools/overview). It hardens and improves your code in the form of pull requests. | ||
|
||
### How does Pixeebot help me? | ||
Pixeebot is powered by the open-source [codemodder framework](https://codemodder.io/). These codemods power Pixeebot’s fixes, and are continuously updated to ensure Pixeebot’s recommendations align with industry standards and best practices. | ||
|
||
Pixeebot monitors your repositories and provides fixes in two different ways: | ||
### How does Pixeebot help me? | ||
|
||
1. :on: **Continuous Improvement:** monitors your default branch and sends you pull requests with fixes. | ||
1. 🗃️ **Continuous Improvement:** works down your backlog of issues and keeps your codebase secure. | ||
2. :seedling: **PR Improvement:** checks each new pull request (PR) and recommends improvements. | ||
3. 🔎 **Triage**: identifies false positives and prioritizes issues that need fixing. | ||
|
||
### What types of recommendations does Pixeebot make? | ||
### What types of issues can Pixeebot triage and fix? | ||
|
||
Pixeebot is built to find and fix a variety of problems, whether they are performance and quality issues or known security vulnerabilities. Here are a few of the most common issues Pixeebot resolves: | ||
Pixeebot can triage and fix a wide range of security issues detected by code scanning tools. Many of these issues are common across tools and languages, such as: | ||
|
||
- NullPointerExceptions | ||
- Cross Site Scripting (XSS) and XML External Entity (XXE) attack vulnerabilities | ||
- Denial of Service (DoS) attack vulnerabilities | ||
- SQL injection vulnerailities | ||
- Removal of unnecessary F-strings | ||
- SQL Injection | ||
- Cross-Site Scripting (XSS) | ||
- Insecure Deserialization | ||
- Insecure Randomness | ||
- Unsafe XML Parsing | ||
- Insecure Cookie Handling | ||
- Command Injection | ||
- Insecure Configuration | ||
|
||
### How can I test Pixeebot? | ||
|
||
Pixeebot is quick to install and starts working immediately upon activation. While Pixeebot is designed for repositories of all sizes, it is most effective at identifying vulnerabilities in active medium to large-sized projects. | ||
Pixeebot is available as a GitHub App on the [GitHub Marketplace](https://github.com/apps/pixeebot/). We provide a free tier offering that can be installed on any public or private repository. This is a great way to get started with Pixeebot and see how it can help to harden and secure your code. | ||
|
||
If you need a repository to test with, we recommend trying Pixeebot out with a deliberately insecure application. Template repositories containing Java and Python test applications are available in PixeeSandbox: [https://github.com/PixeeSandbox](https://github.com/PixeeSandbox) | ||
|
||
Testing with these deliberately insecure applications can give you an idea of how Pixeebot works, before installing it directly on your personal or professional repositories. | ||
|
||
For additional details, see the [Installation](/installing) page. | ||
|
||
Pixeebot also supports on-premises deployment for organizations that require additional security or compliance measures. To learn more about Pixeebot on-premises solutions, please [contact us](https://pixee.ai/demo-landing-page). | ||
|
||
### What environment & languages does Pixeebot support? | ||
|
||
Pixeebot is currently available for Java and Python repositories on GitHub, with support for additional languages coming soon. Have a language you’d like to see supported? Let us know in an email to [[email protected]](mailto:[email protected]). We’d love to hear from you! | ||
Pixeebot supports a wide variety of languages and code scanning tools. For a full list of supported languages, tools, and rules, see the [Code Scanning Tools](/code-scanning-tools/overview) page. | ||
|
||
### What does Pixeebot cost? | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters