Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds transcend url to tr-scan-packages command #377

Merged
merged 1 commit into from
Jan 13, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 47 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,141 +12,145 @@
- [Authentication](#authentication)
- [Arguments](#arguments)
- [Usage](#usage-1)
- [tr-push](#tr-push)
- [tr-pull-ot](#tr-pull-ot)
- [Authentication](#authentication-1)
- [Arguments](#arguments-1)
- [Usage](#usage-2)
- [CI Integration](#ci-integration)
- [Dynamic Variables](#dynamic-variables)
- [tr-scan-packages](#tr-scan-packages)
- [tr-push](#tr-push)
- [Authentication](#authentication-2)
- [Arguments](#arguments-2)
- [Usage](#usage-3)
- [tr-discover-silos](#tr-discover-silos)
- [CI Integration](#ci-integration)
- [Dynamic Variables](#dynamic-variables)
- [tr-scan-packages](#tr-scan-packages)
- [Authentication](#authentication-3)
- [Arguments](#arguments-3)
- [Usage](#usage-4)
- [tr-request-approve](#tr-request-approve)
- [tr-discover-silos](#tr-discover-silos)
- [Authentication](#authentication-4)
- [Arguments](#arguments-4)
- [Usage](#usage-5)
- [tr-request-cancel](#tr-request-cancel)
- [tr-request-approve](#tr-request-approve)
- [Authentication](#authentication-5)
- [Arguments](#arguments-5)
- [Usage](#usage-6)
- [tr-request-notify-additional-time](#tr-request-notify-additional-time)
- [tr-request-cancel](#tr-request-cancel)
- [Authentication](#authentication-6)
- [Arguments](#arguments-6)
- [Usage](#usage-7)
- [tr-request-mark-silent](#tr-request-mark-silent)
- [tr-request-notify-additional-time](#tr-request-notify-additional-time)
- [Authentication](#authentication-7)
- [Arguments](#arguments-7)
- [Usage](#usage-8)
- [tr-request-upload](#tr-request-upload)
- [tr-request-mark-silent](#tr-request-mark-silent)
- [Authentication](#authentication-8)
- [Arguments](#arguments-8)
- [Usage](#usage-9)
- [tr-request-restart](#tr-request-restart)
- [tr-request-upload](#tr-request-upload)
- [Authentication](#authentication-9)
- [Arguments](#arguments-9)
- [Usage](#usage-10)
- [tr-request-enricher-restart](#tr-request-enricher-restart)
- [tr-request-restart](#tr-request-restart)
- [Authentication](#authentication-10)
- [Arguments](#arguments-10)
- [Usage](#usage-11)
- [tr-request-reject-unverified-identifiers](#tr-request-reject-unverified-identifiers)
- [tr-request-enricher-restart](#tr-request-enricher-restart)
- [Authentication](#authentication-11)
- [Arguments](#arguments-11)
- [Usage](#usage-12)
- [tr-request-export](#tr-request-export)
- [tr-request-reject-unverified-identifiers](#tr-request-reject-unverified-identifiers)
- [Authentication](#authentication-12)
- [Arguments](#arguments-12)
- [Usage](#usage-13)
- [tr-cron-pull-identifiers](#tr-cron-pull-identifiers)
- [tr-request-export](#tr-request-export)
- [Authentication](#authentication-13)
- [Arguments](#arguments-13)
- [Usage](#usage-14)
- [tr-cron-mark-identifiers-completed](#tr-cron-mark-identifiers-completed)
- [tr-cron-pull-identifiers](#tr-cron-pull-identifiers)
- [Authentication](#authentication-14)
- [Arguments](#arguments-14)
- [Usage](#usage-15)
- [tr-manual-enrichment-pull-identifiers](#tr-manual-enrichment-pull-identifiers)
- [tr-cron-mark-identifiers-completed](#tr-cron-mark-identifiers-completed)
- [Authentication](#authentication-15)
- [Arguments](#arguments-15)
- [Usage](#usage-16)
- [tr-manual-enrichment-push-identifiers](#tr-manual-enrichment-push-identifiers)
- [tr-manual-enrichment-pull-identifiers](#tr-manual-enrichment-pull-identifiers)
- [Authentication](#authentication-16)
- [Arguments](#arguments-16)
- [Usage](#usage-17)
- [tr-mark-request-data-silos-completed](#tr-mark-request-data-silos-completed)
- [tr-manual-enrichment-push-identifiers](#tr-manual-enrichment-push-identifiers)
- [Authentication](#authentication-17)
- [Arguments](#arguments-17)
- [Usage](#usage-18)
- [tr-skip-request-data-silos](#tr-skip-request-data-silos)
- [tr-mark-request-data-silos-completed](#tr-mark-request-data-silos-completed)
- [Authentication](#authentication-18)
- [Arguments](#arguments-18)
- [Usage](#usage-19)
- [tr-retry-request-data-silos](#tr-retry-request-data-silos)
- [tr-skip-request-data-silos](#tr-skip-request-data-silos)
- [Authentication](#authentication-19)
- [Arguments](#arguments-19)
- [Usage](#usage-20)
- [tr-update-consent-manager](#tr-update-consent-manager)
- [tr-retry-request-data-silos](#tr-retry-request-data-silos)
- [Authentication](#authentication-20)
- [Arguments](#arguments-20)
- [Usage](#usage-21)
- [tr-consent-managers-to-business-entities](#tr-consent-managers-to-business-entities)
- [tr-update-consent-manager](#tr-update-consent-manager)
- [Authentication](#authentication-21)
- [Arguments](#arguments-21)
- [Usage](#usage-22)
- [tr-consent-manager-service-json-to-yml](#tr-consent-manager-service-json-to-yml)
- [tr-consent-managers-to-business-entities](#tr-consent-managers-to-business-entities)
- [Authentication](#authentication-22)
- [Arguments](#arguments-22)
- [Usage](#usage-23)
- [tr-derive-data-silos-from-data-flows](#tr-derive-data-silos-from-data-flows)
- [tr-consent-manager-service-json-to-yml](#tr-consent-manager-service-json-to-yml)
- [Authentication](#authentication-23)
- [Arguments](#arguments-23)
- [Usage](#usage-24)
- [tr-derive-data-silos-from-data-flows-cross-instance](#tr-derive-data-silos-from-data-flows-cross-instance)
- [tr-derive-data-silos-from-data-flows](#tr-derive-data-silos-from-data-flows)
- [Authentication](#authentication-24)
- [Arguments](#arguments-24)
- [Usage](#usage-25)
- [tr-pull-consent-metrics](#tr-pull-consent-metrics)
- [tr-derive-data-silos-from-data-flows-cross-instance](#tr-derive-data-silos-from-data-flows-cross-instance)
- [Authentication](#authentication-25)
- [Arguments](#arguments-25)
- [Usage](#usage-26)
- [tr-pull-datapoints](#tr-pull-datapoints)
- [tr-pull-consent-metrics](#tr-pull-consent-metrics)
- [Authentication](#authentication-26)
- [Arguments](#arguments-26)
- [Usage](#usage-27)
- [tr-upload-preferences](#tr-upload-preferences)
- [tr-pull-datapoints](#tr-pull-datapoints)
- [Authentication](#authentication-27)
- [Authentication](#authentication-28)
- [Arguments](#arguments-27)
- [Usage](#usage-28)
- [tr-upload-consent-preferences](#tr-upload-consent-preferences)
- [tr-upload-preferences](#tr-upload-preferences)
- [Authentication](#authentication-28)
- [Authentication](#authentication-29)
- [Arguments](#arguments-28)
- [Usage](#usage-29)
- [tr-pull-consent-preferences](#tr-pull-consent-preferences)
- [tr-upload-consent-preferences](#tr-upload-consent-preferences)
- [Authentication](#authentication-30)
- [Arguments](#arguments-29)
- [Usage](#usage-30)
- [tr-upload-data-flows-from-csv](#tr-upload-data-flows-from-csv)
- [tr-pull-consent-preferences](#tr-pull-consent-preferences)
- [Authentication](#authentication-31)
- [Arguments](#arguments-30)
- [Usage](#usage-31)
- [tr-upload-cookies-from-csv](#tr-upload-cookies-from-csv)
- [tr-upload-data-flows-from-csv](#tr-upload-data-flows-from-csv)
- [Authentication](#authentication-32)
- [Arguments](#arguments-31)
- [Usage](#usage-32)
- [tr-generate-api-keys](#tr-generate-api-keys)
- [tr-upload-cookies-from-csv](#tr-upload-cookies-from-csv)
- [Authentication](#authentication-33)
- [Arguments](#arguments-32)
- [Usage](#usage-33)
- [tr-build-xdi-sync-endpoint](#tr-build-xdi-sync-endpoint)
- [tr-generate-api-keys](#tr-generate-api-keys)
- [Authentication](#authentication-34)
- [Arguments](#arguments-33)
- [Usage](#usage-34)
- [tr-build-xdi-sync-endpoint](#tr-build-xdi-sync-endpoint)
- [Authentication](#authentication-35)
- [Arguments](#arguments-34)
- [Usage](#usage-35)
- [Prompt Manager](#prompt-manager)
- [Proxy usage](#proxy-usage)

Expand Down Expand Up @@ -831,12 +835,13 @@ The API key needs the following scopes:

#### Arguments

| Argument | Description | Type | Default | Required |
| ----------- | ------------------------------------------------------------- | -------- | --------------------------------------------------------- | -------- |
| auth | Transcend API key. | string | N/A | true |
| scanPath | File path in the project to scan. | string | ./ | false |
| ignoreDirs | List of directories to ignore in scan | string[] | [] | false |
| packageName | Name of the git repository that the package should be tied to | string | $(`cd ${scanPath} && git config --get remote.origin.url`) | false |
| Argument | Description | Type | Default | Required |
| ------------ | ----------------------------------------------------------------------------- | ------------ | --------------------------------------------------------- | -------- |
| auth | Transcend API key. | string | N/A | true |
| scanPath | File path in the project to scan. | string | ./ | false |
| ignoreDirs | List of directories to ignore in scan | string[] | [] | false |
| packageName | Name of the git repository that the package should be tied to | string | $(`cd ${scanPath} && git config --get remote.origin.url`) | false |
| transcendUrl | URL of the Transcend backend. Use https://api.us.transcend.io for US hosting. | string - URL | https://api.transcend.io | false |

#### Usage

Expand Down
Loading