Skip to content

Commit f685827

Browse files
VeronicaSnykgitbook-bot
authored andcommitted
GITBOOK-7042: aw-DNM: CLI: Add .NET Early Access command line flags to CLI docs
1 parent a096d0a commit f685827

File tree

335 files changed

+1132
-1143
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

335 files changed

+1132
-1143
lines changed

docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Start using Snyk
66

7-
<table data-header-hidden><thead><tr><th></th><th width="164.33333333333331"></th><th width="188"></th><th></th></tr></thead><tbody><tr><td>​<a href="getting-started/">Getting started</a><br>Start running Snyk to secure your code</td><td><a href="enterprise-configuration/">Enterprise configuration</a><br>Use Snyk in an enterprise system</td><td><a href="implement-snyk/">Implement Snyk</a><br>Set up Snyk to run in your business</td><td><a href="getting-started/supported-languages-frameworks-and-feature-availability-overview/">Supported languages</a><br>Match your language and framework to Snyk</td></tr></tbody></table>
7+
<table data-header-hidden><thead><tr><th></th><th width="164.33333333333331"></th><th width="188"></th><th></th></tr></thead><tbody><tr><td>​<a href="getting-started/">Getting started</a><br>Start running Snyk to secure your code</td><td><a href="enterprise-configuration/">Enterprise configuration</a><br>Use Snyk in an enterprise system</td><td><a href="implement-snyk/">Implement Snyk</a><br>Set up Snyk to run in your business</td><td><a href="scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/">Supported languages</a><br>Match your language and framework to Snyk</td></tr></tbody></table>
88

99
## Integrate with Snyk <a href="#explore-snyk-products" id="explore-snyk-products"></a>
1010

docs/SUMMARY.md

+208-208
Large diffs are not rendered by default.

docs/enterprise-configuration/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Snyk has a number of tools and processes that help secure your entire software d
2222
For users who are evaluating Snyk or planning an enterprise deployment, and for most programming languages, Snyk recommends integrating with a Git repository to get started.
2323

2424
{% hint style="info" %}
25-
The tool that best serves your tech stack, environment, and workflow depends on your individual circumstances. See [Supported languages and frameworks ](../getting-started/supported-languages-frameworks-and-feature-availability-overview/)for the guide specific to your language for more details.
25+
The tool that best serves your tech stack, environment, and workflow depends on your individual circumstances. See [Supported languages and frameworks ](../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/)for the guide specific to your language for more details.
2626
{% endhint %}
2727

2828
To learn more about choosing the best integration points within the software development lifecycle for you and for your team, at their current level of security maturity, see [Integrating Snyk at your company](https://learn.snyk.io/lesson/integrate-snyk-at-your-company/).

docs/enterprise-configuration/snyk-broker/snyk-broker-code-agent/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
{% hint style="info" %}
44
<mark style="color:red;">**The Code Agent is deprecated**</mark>. The preferred method of running Snyk Code analysis using Snyk Broker is through [Brokered Code](../install-and-configure-snyk-broker/advanced-configuration-for-snyk-broker-docker-installation/snyk-code-clone-capability-with-broker-for-docker.md). The Code Agent is an alternative method without advantages. For details, contact your Snyk Integration Consultant or Technical Success Manager or contact [Snyk Support](https://support.snyk.io/hc/en-us).
55

6-
The automatic [PR Checks](../../../scan-using-snyk/pull-requests/pull-request-checks/) feature is not supported ifor Snyk Broker - Code Agent.
6+
The automatic [PR Checks](../../../scan-with-snyk/pull-requests/pull-request-checks/) feature is not supported ifor Snyk Broker - Code Agent.
77
{% endhint %}
88

99
To connect Snyk Code to your self-hosted Git server using Snyk Broker, you can add the Code Agent after installing Snyk Broker for your SCM.&#x20;
@@ -12,7 +12,7 @@ To connect Snyk Code to your self-hosted Git server using Snyk Broker, you can a
1212

1313
The Code Agent is available as a [Docker image](https://hub.docker.com/r/snyk/code-agent/). The Code Agent is supported only for Snyk Broker version 4.108.0 and later versions. If you already have a running Broker Client, you must update it by pulling the latest Docker image.
1414

15-
Deploying the Broker client and Code Agent creates two separate services. that, along with the Broker server, [Snyk Code AI Engine](../../../scan-using-snyk/snyk-code/#ai-engine), and Snyk Web UI, enable the following Code Analysis workflow:
15+
Deploying the Broker client and Code Agent creates two separate services. that, along with the Broker server, [Snyk Code AI Engine](../../../scan-with-snyk/snyk-code/#ai-engine), and Snyk Web UI, enable the following Code Analysis workflow:
1616

1717
1. On the Snyk Web UI, a user initiates a request to import a repository from a self-hosted Git server to Snyk for Code Analysis. The request can also be initiated from the Snyk API v1, by using the [Import targets request](https://snyk.docs.apiary.io/#reference/import-projects/import/import-targets).
1818
2. The request arrives at the Broker server, which sends the request to the Broker client, which sends the request to the Code Agent. The Broker client automatically provides the Code Agent with the connection details to the integrated SCM, which stores the required repositories.
@@ -26,7 +26,7 @@ Deploying the Broker client and Code Agent creates two separate services. that,
2626

2727
You have installed a Broker client.
2828

29-
The maximum file size you can import using the Code Agent deployment method is 1MB. For more information, see [File size limit for Snyk Code analysis](../../../getting-started/supported-languages-frameworks-and-feature-availability-overview/technical-specifications.md#file-size-limit-for-snyk-code-analysis).
29+
The maximum file size you can import using the Code Agent deployment method is 1MB. For more information, see [File size limit for Snyk Code analysis](../../../getting-started/supported-languages-and-frameworks/technical-specifications.md#file-size-limit-for-snyk-code-analysis).
3030

3131
You must have the ability to run a Docker Container, for example, by using a Docker Desktop or Kubernetes.
3232

docs/getting-started/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ A robust security process secures each of these components where they are built
1616

1717
## Use Snyk in your workflow
1818

19-
* **Secure your code**: use [Snyk Open Source](../scan-using-snyk/snyk-open-source/) to fix vulnerabilities in your open source dependencies and [Snyk Code](../scan-using-snyk/snyk-code/) to fix vulnerabilities in your source code.
20-
* **Secure your containers**: use [Snyk Container](../scan-using-snyk/snyk-container/) to fix vulnerabilities in container images and Kubernetes applications.
21-
* **Secure your infrastructure**: use [Snyk Infrastructure as Code (IaC)](../scan-using-snyk/snyk-iac/scan-your-iac-source-code/) to fix misconfigurations in Terraform, CloudFormation, Kubernetes, and Azure templates. Use [IaC+](../scan-using-snyk/snyk-iac/iac+-code-to-cloud-capabilities/) to fix misconfigurations in Amazon Web Services accounts, Microsoft Azure subscriptions, and Google Cloud Projects.
19+
* **Secure your code**: use [Snyk Open Source](../scan-with-snyk/snyk-open-source/) to fix vulnerabilities in your open source dependencies and [Snyk Code](../scan-with-snyk/snyk-code/) to fix vulnerabilities in your source code.
20+
* **Secure your containers**: use [Snyk Container](../scan-with-snyk/snyk-container/) to fix vulnerabilities in container images and Kubernetes applications.
21+
* **Secure your infrastructure**: use [Snyk Infrastructure as Code (IaC)](../scan-with-snyk/snyk-iac/scan-your-iac-source-code/) to fix misconfigurations in Terraform, CloudFormation, Kubernetes, and Azure templates. Use [IaC+](../scan-with-snyk/snyk-iac/iac+-code-to-cloud-capabilities/) to fix misconfigurations in Amazon Web Services accounts, Microsoft Azure subscriptions, and Google Cloud Projects.
2222

2323
## Choose how to run Snyk
2424

@@ -39,9 +39,9 @@ Running Snyk from the command line.
3939

4040
The Snyk tech stacks that are supported depend on the Snyk product you use:
4141

42-
* **Snyk Open Source** and **Snyk Code**: see [Supported languages and frameworks](supported-languages-frameworks-and-feature-availability-overview/).
43-
* **Snyk Container**: see [Supported operating system distributions](../scan-using-snyk/snyk-container/how-snyk-container-works/supported-operating-system-distributions.md).
44-
* **Snyk Infrastructure as Code**: see [Supported IaC and cloud providers](../scan-using-snyk/snyk-iac/supported-iac-languages-cloud-providers-and-cloud-resources/).
42+
* **Snyk Open Source** and **Snyk Code**: see [Supported languages and frameworks](../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/).
43+
* **Snyk Container**: see [Supported operating system distributions](../scan-with-snyk/snyk-container/how-snyk-container-works/supported-operating-system-distributions.md).
44+
* **Snyk Infrastructure as Code**: see [Supported IaC and cloud providers](../scan-with-snyk/snyk-iac/supported-iac-languages-cloud-providers-and-cloud-resources/).
4545

4646
## What can Snyk integrate with?
4747

docs/getting-started/glossary.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -126,11 +126,11 @@ A measure of how practical an exploit for a vulnerability is, based on whether t
126126

127127
### Fixable / Partially fixable
128128

129-
A measure of whether a vulnerability can be fixed by Sny by applying a patch, upgrade, or pin. See [Vulnerability fix types](../scan-using-snyk/snyk-open-source/manage-vulnerabilities/vulnerability-fix-types.md).
129+
A measure of whether a vulnerability can be fixed by Sny by applying a patch, upgrade, or pin. See [Vulnerability fix types](../scan-with-snyk/snyk-open-source/manage-vulnerabilities/vulnerability-fix-types.md).
130130

131131
### Fix PR
132132

133-
A pull request with an automatic fix for discovered vulnerabilities that Snyk can offer the user. See [Automated fix PRs](../scan-using-snyk/pull-requests/snyk-fix-pull-or-merge-requests/create-automatic-fix-prs-for-backlog-issues-and-known-vulnerabilities.md).
133+
A pull request with an automatic fix for discovered vulnerabilities that Snyk can offer the user. See [Automated fix PRs](../scan-with-snyk/pull-requests/snyk-fix-pull-or-merge-requests/create-automatic-fix-prs-for-backlog-issues-and-known-vulnerabilities.md).
134134

135135
## G
136136

@@ -234,7 +234,7 @@ Pull Request. Allows a user to exchange changes made to source code and collabor
234234

235235
### PR Checks
236236

237-
Use Snyk PR Checks to prevent new security issues from entering your codebase by automatically scanning code changes in real-time as soon as you submit a pull request (PR) in your source code manager (SCM). See [Run PR Checks](../scan-using-snyk/pull-requests/pull-request-checks/).
237+
Use Snyk PR Checks to prevent new security issues from entering your codebase by automatically scanning code changes in real-time as soon as you submit a pull request (PR) in your source code manager (SCM). See [Run PR Checks](../scan-with-snyk/pull-requests/pull-request-checks/).
238238

239239
### Priority Score
240240

@@ -268,7 +268,7 @@ A value assigned to an issue, ranging from 0 to 1,000, representing the risk imp
268268

269269
### Rule
270270

271-
A security policy that checks cloud infrastructure and infrastructure as code (IaC) for misconfigurations that can lead to security problems, or a security rule used by Snyk Code when scanning your source code for vulnerabilities. For more information, see [Snyk Code security rules](../scan-using-snyk/snyk-code/snyk-code-security-rules/) and [IaC custom rules](../scan-using-snyk/snyk-iac/build-your-own-iac-custom-rules/).
271+
A security policy that checks cloud infrastructure and infrastructure as code (IaC) for misconfigurations that can lead to security problems, or a security rule used by Snyk Code when scanning your source code for vulnerabilities. For more information, see [Snyk Code security rules](../scan-with-snyk/snyk-code/snyk-code-security-rules/) and [IaC custom rules](../scan-with-snyk/snyk-iac/build-your-own-iac-custom-rules/).
272272

273273
## S
274274

@@ -338,19 +338,19 @@ A Snyk platform tool that enables developers to find and fix known vulnerabiliti
338338

339339
### Snyk Code
340340

341-
A Snyk product. A SAST product enabling developers to find and fix vulnerabilities in your proprietary application code. See [Snyk Code](../scan-using-snyk/snyk-code/).
341+
A Snyk product. A SAST product enabling developers to find and fix vulnerabilities in your proprietary application code. See [Snyk Code](../scan-with-snyk/snyk-code/).
342342

343343
### Snyk Container
344344

345-
A Snyk product. Enables developers to find and fix vulnerabilities in container images and Kubernetes applications. See [Snyk Container](../scan-using-snyk/snyk-container/).
345+
A Snyk product. Enables developers to find and fix vulnerabilities in container images and Kubernetes applications. See [Snyk Container](../scan-with-snyk/snyk-container/).
346346

347347
### Snyk Infrastructure as Code
348348

349-
A Snyk product. Enables developers to find and fix vulnerabilities in Kubernetes, Helm, and Terraform configuration files. See [Snyk Infrastructure as Code](../scan-using-snyk/snyk-iac/scan-your-iac-source-code/).
349+
A Snyk product. Enables developers to find and fix vulnerabilities in Kubernetes, Helm, and Terraform configuration files. See [Snyk Infrastructure as Code](../scan-with-snyk/snyk-iac/scan-your-iac-source-code/).
350350

351351
### Snyk Open Source
352352

353-
A Snyk product. Enables developers to find and fix open-source vulnerabilities. See [Snyk Open Source](../scan-using-snyk/snyk-open-source/).
353+
A Snyk product. Enables developers to find and fix open-source vulnerabilities. See [Snyk Open Source](../scan-with-snyk/snyk-open-source/).
354354

355355
### Snyk plugin
356356

@@ -401,7 +401,7 @@ A fix type: a problem can be fixed by upgrading a version of a package or by app
401401

402402
### Vulnerability
403403

404-
A security vulnerability that was identified by Snyk. See [Manage vulnerabilities](../scan-using-snyk/snyk-open-source/manage-vulnerabilities/).
404+
A security vulnerability that was identified by Snyk. See [Manage vulnerabilities](../scan-with-snyk/snyk-open-source/manage-vulnerabilities/).
405405

406406
## W
407407

docs/getting-started/quickstart/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This quickstart helps you with these basic tasks in the Snyk application:
44

55
{% hint style="info" %}
6-
Before starting, check that the code in your repositories matches Snyk's [supported languages and frameworks](../supported-languages-frameworks-and-feature-availability-overview/).
6+
Before starting, check that the code in your repositories matches Snyk's [supported languages and frameworks](../../scan-using-snyk/supported-languages-frameworks-and-feature-availability-overview/).
77
{% endhint %}
88

99
1. [Create a Snyk account](create-or-log-in-to-a-snyk-account.md).
@@ -13,7 +13,7 @@ Before starting, check that the code in your repositories matches Snyk's [suppor
1313

1414
### For more details
1515

16-
* See [Start scanning ](../../scan-using-snyk/start-scanning-using-the-cli-web-ui-or-api.md)to start using Snyk capabilities.
16+
* See [Start scanning ](../../scan-with-snyk/start-scanning-using-the-cli-web-ui-or-api.md)to start using Snyk capabilities.
1717
* See [Walkthrough: Code Repository Projects](../../implement-snyk/walkthrough-code-repository-projects/) to read a full walkthrough of scanning and fixing vulnerabilities from content stored in a Git repository.
1818
* Visit [Snyk Learn](https://learn.snyk.io/catalog/product-training/) for related introductory training
1919

@@ -28,7 +28,7 @@ Snyk supports the latest versions of the following web browsers:
2828
* [Chrome](https://www.google.com/chrome/)
2929
* [Edge](https://www.microsoft.com/en-us/edge?form=MA13FJ)
3030
* [Firefox](https://www.mozilla.org/en-US/firefox/new/)
31-
* [Safari](https://www.apple.com/safari/) (except for [Opening Fix PR](../../scan-using-snyk/pull-requests/snyk-fix-pull-or-merge-requests/))
31+
* [Safari](https://www.apple.com/safari/) (except for [Opening Fix PR](../../scan-with-snyk/pull-requests/snyk-fix-pull-or-merge-requests/))
3232

3333
{% hint style="info" %}
3434
Snyk requires Javascript to be enabled on your browser.

docs/getting-started/quickstart/view-snyk-scan-results.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ This shows the number of issues found, grouped by severity level (**C**ritical,
1313

1414
The scan results and available actions depend on the type of Project you scan:
1515

16-
* Open-source libraries: see [Snyk Open Source](../../scan-using-snyk/snyk-open-source/).
17-
* Application code: see [Snyk Code](../../scan-using-snyk/snyk-code/).
16+
* Open-source libraries: see [Snyk Open Source](../../scan-with-snyk/snyk-open-source/).
17+
* Application code: see [Snyk Code](../../scan-with-snyk/snyk-code/).
1818
* Container images: see [Snyk Container](../../scan-using-snyk/snyk-container/scan-container-images.md).
19-
* Infrastructure as Code (IaC), Kubernetes, Helm and Terraform configuration files and cloud misconfigurations: see [Scan infrastructure](../../scan-using-snyk/snyk-iac/).
19+
* Infrastructure as Code (IaC), Kubernetes, Helm and Terraform configuration files and cloud misconfigurations: see [Scan infrastructure](../../scan-with-snyk/snyk-iac/).
2020

2121
## **What's next?**
2222

docs/getting-started/snyk-release-process.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Not all features follow all these stages, and timelines for each feature to move
1616

1717
### Snyk features in Closed Beta
1818

19-
* [Customize PR templates](../scan-using-snyk/pull-requests/snyk-fix-pull-or-merge-requests/customize-pr-templates/)
20-
* [Configure PR Checks](../scan-using-snyk/pull-requests/pull-request-checks/configure-pull-request-checks.md)
19+
* [Customize PR templates](../scan-with-snyk/pull-requests/snyk-fix-pull-or-merge-requests/customize-pr-templates/)
20+
* [Configure PR Checks](../scan-with-snyk/pull-requests/pull-request-checks/configure-pull-request-checks.md)
2121
* [Publish Snyk Code CLI results](../snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-cli-for-snyk-code/publish-snyk-code-cli-results-and-ignore-issues.md)
2222
* [Enterprise Analytics](../manage-risk/analytics/)
2323
* [Snyk Code - Clone capability with Broker for Docker](../enterprise-configuration/snyk-broker/install-and-configure-snyk-broker/advanced-configuration-for-snyk-broker-docker-installation/snyk-code-clone-capability-with-broker-for-docker.md)
@@ -31,12 +31,12 @@ Not all features follow all these stages, and timelines for each feature to move
3131

3232
* [Snyk GitHub Cloud App](../integrate-with-snyk/git-repositories-scms-integrations-with-snyk/snyk-github-cloud-app.md)
3333
* [Automatically created Project collections](../snyk-admin/introduction-to-snyk-projects/automatically-created-project-collections.md)
34-
* [Custom rules](../scan-using-snyk/snyk-code/snyk-code-custom-rules/)
34+
* [Custom rules](../scan-with-snyk/snyk-code/snyk-code-custom-rules/)
3535
* [Risk Score](../manage-risk/prioritize-your-issues/risk-score.md)
3636
* [Reachable vulnerabilities](../manage-risk/prioritize-your-issues/reachable-vulnerabilities.md)
3737
* [Group projects by branch or version for monitoring](../snyk-cli/scan-and-maintain-projects-using-the-cli/group-projects-by-branch-or-version-for-monitoring.md)
3838
* [Git repository cloning](../snyk-admin/snyk-preview.md#enable-git-repository-cloning)
39-
* [Fix code vulnerabilities automatically](../scan-using-snyk/snyk-code/manage-code-vulnerabilities/fix-code-vulnerabilities-automatically.md)
39+
* [Fix code vulnerabilities automatically](../scan-with-snyk/snyk-code/manage-code-vulnerabilities/fix-code-vulnerabilities-automatically.md)
4040
* [Snyk broker commit signing](../enterprise-configuration/snyk-broker/snyk-broker-commit-signing.md)
4141

4242
## General Availability

docs/getting-started/snyk-web-ui.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Snyk tracks and flags Pull Requests (PRs) in the top-most vulnerable projects, i
4848
* PRs that can be raised to fix vulnerabilities in some of the most vulnerable Projects.
4949
* PRs that have already been raised by or through Snyk and are open and awaiting review.
5050

51-
For Projects with the **Fix vulnerabilities** link, use this link to view Project details with an option to open a fix PR. See [Snyk Fix Pull or Merge Requests](../scan-using-snyk/pull-requests/snyk-fix-pull-or-merge-requests/) for more details.
51+
For Projects with the **Fix vulnerabilities** link, use this link to view Project details with an option to open a fix PR. See [Snyk Fix Pull or Merge Requests](../scan-with-snyk/pull-requests/snyk-fix-pull-or-merge-requests/) for more details.
5252

5353
{% hint style="warning" %}
5454
Currently, Snyk tracks and flags PRs in GitHub, GitHub Enterprise, and Bitbucket Cloud only, and only for the top-most vulnerable Projects. If you use another SCM, the **Pending tasks** section shows PRs that can be raised but not PRs that have already been raised.

0 commit comments

Comments
 (0)