Skip to content

Commit

Permalink
docs: Update to differentiate Bearer CLI and Bearer Pro (#1728)
Browse files Browse the repository at this point in the history
  • Loading branch information
gmontard authored Dec 16, 2024
1 parent cc82a8f commit 59ea216
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 17 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,9 @@
<hr/>
Scan your source code against top <strong>security</strong> and <strong>privacy</strong> risks.
<br /><br />
Bearer CLI is a static application security testing (SAST) tool that scans your source code and analyzes your data flows to discover, filter and prioritize security and privacy risks.
<br /><br />
Currently supporting: <strong>JavaScript/TypeScript</strong>, <strong>Ruby</strong>, <strong>PHP</strong>, <strong>Java</strong>, <strong>Go</strong>, <strong>Python</strong> - <a href="https://docs.bearer.com/reference/supported-languages/">Learn more</a>

Bearer is a static application security testing (SAST) tool designed to scan your source code and analyze data flows to identify, filter, and prioritize security and privacy risks.
<br/><br/>
Bearer offers a free, open solution, Bearer CLI, and a commercial solution, Bearer Pro, available through <a href="https://cycode.com/">Cycode</a>.
<br /><br />

[Getting Started](#rocket-getting-started) - [FAQ](#question-faqs) - [Documentation](https://docs.bearer.com) - [Report a Bug](https://github.com/Bearer/bearer/issues/new/choose) - [Discord Community][discord]
Expand All @@ -29,8 +28,14 @@
[![Discord](https://img.shields.io/discord/1042147477765242973?label=discord)][discord]
</div>

## Developer friendly static code analysis for security and privacy

## Language Support
**Bearer CLI**: Go • Java • JavaScript • TypeScript • PHP • Python • Ruby <br/>
**Bearer Pro by Cycode**: C# • Kotlin • Elixir *+ everything in Bearer OSS*

<a href="https://docs.bearer.com/reference/supported-languages/">Learn more about language suppport</a>

## Developer friendly static code analysis for security and privacy
<hr/>

<https://user-images.githubusercontent.com/1649672/230438696-9bb0fd35-2aa9-4273-9970-733189d01ff1.mp4>
Expand Down
55 changes: 43 additions & 12 deletions docs/reference/supported-languages.njk
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ supportChart:
rules: true
searchName: lang-ruby
searchTerm: ruby_
status: GA
support: Bearer CLI + Pro
javascript:
name: JavaScript / TypeScript
frameworks:
Expand All @@ -18,45 +18,72 @@ supportChart:
rules: true
searchName: lang-jsts
searchTerm: javascript_
status: GA
support: Bearer CLI + Pro
java:
name: Java
frameworks:
- Spring
- Java
rules: true
searchName: lang-java
searchTerm: java_
status: GA
support: Bearer CLI + Pro
php:
name: PHP
frameworks:
- Symfony
rules: true
searchName: lang-php
searchTerm: php_
status: GA
support: Bearer CLI + Pro
go:
name: Go
frameworks:
- Gorilla
rules: true
searchName: lang-go
searchTerm: go_
status: GA
support: Bearer CLI + Pro
python:
name: Python
frameworks:
- Django
rules: true
searchName: lang-python
searchTerm: python_
status: GA
support: Bearer CLI + Pro
csharp:
name: C#
frameworks:
- .Net
rules: true
searchName: lang-csharp
searchTerm: csharp_
support: Bearer Pro
kotlin:
name: Kotlin
frameworks:
- Android
- Spring
- Ktor
rules: true
searchName: lang-kotlin
searchTerm: kotlin_
support: Bearer Pro
elixir:
name: Elixir
frameworks:
- Phoenix
rules: true
searchName: lang-elixir
searchTerm: elixir_
support: Bearer Pro

---
{% renderTemplate "liquid,md" %}
# Supported languages

Bearer CLI supports the following language and framework combinations.
Bearer supports the following language and framework combinations.
When you scan a codebase, Bearer will automatically select the appropriate language based on the file extension. For example, if your application is composed of Ruby and JavaScript code, Bearer will automatically apply the right language and set of rules.

{% endrenderTemplate %}
Expand All @@ -67,7 +94,7 @@ When you scan a codebase, Bearer will automatically select the appropriate langu
<th>Languages</th>
<th>Frameworks</th>
<th># rules</th>
<th>Status</th>
<th>Support</th>
</tr>
</thead>
<tbody>
Expand All @@ -84,14 +111,18 @@ When you scan a codebase, Bearer will automatically select the appropriate langu
{% endif %}
</td>
<td>
{% if data.rules %}
<a href="/reference/rules/?{{data.searchName}}={{data.searchTerm}}">{{rules.counts.languages[language].count}}</a>
{% if data.support == "Bearer Pro" %}
<a class="italic" target="_window" href="https://cycode.com/sast-static-application-security-testing/">Learn more</a>
{% else %}
-
{% if data.rules %}
<a href="/reference/rules/?{{data.searchName}}={{data.searchTerm}}">{{rules.counts.languages[language].count}}</a>
{% else %}
-
{% endif %}
{% endif %}
</td>
<td>
{{ data.status }}<br/>
{{ data.support }}<br/>
{% if data.comment_link %}
<span class="italic text-xs"><a href="{{data.comment_link}}">{{ data.comment }}</a></span>
{% else %}
Expand Down

0 comments on commit 59ea216

Please sign in to comment.