Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/preziosiraffaele/sf-debug-log
https://github.com/preziosiraffaele/sf-debug-log
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/preziosiraffaele/sf-debug-log
- Owner: PreziosiRaffaele
- Created: 2023-10-13T20:59:09.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-18T22:04:57.000Z (10 months ago)
- Last Synced: 2024-01-19T23:19:09.752Z (10 months ago)
- Language: TypeScript
- Size: 353 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# sf-debug-log
Commands to manage Salesforce debug logs.
Create trace flags for any user in the org selecting the debug level and time.
Retrive Apex logs related to a specific user to analyze them locally.
## Install
```bash
sf plugins install sf-debug-log
```
## Commands
- [`sf trace new`](#sf-trace-new)
- [`sf debug retrieve`](#sf-debug-retrieve)
- [`sf debug delete`](#sf-debuglevel-new)
- [`sf debuglevel new`](#sf-debuglevel-new)
## `sf trace new`
```
USAGE
$ sf trace new -o [-u ] [-t ]
FLAGS
-o, --targetusername= [required] Username or alias of the target Salesforce org.
-t, --time= [default: 60] The number of minutes to trace.
-u, --name= [default: targetusername] Username, Name, or ID of the user for whom you want to retrieve the logs.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Create a new trace flag.
This command is used to create a trace flag for a specific user in the Salesforce org.
EXAMPLES
sf trace new -o DeveloperEdition -u "Raffaele Preziosi" -t 10
```
## `sf debug retrieve`
```
USAGE
$ sf debug retrieve -o [-u ] [-t ] [-d ]
FLAGS
-d, --folder= [default: .sfdx/tools/debug/logs] The folder where the retrieved log files will be stored.
-o, --targetusername= (required) Username or alias of the target Salesforce org.
-t, --time= [default: 60] The number of minutes to retrieve log files for.
-u, --user= [default: targetusername] Username, Name, or ID of the user for whom you want to retrieve the logs.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Retrieve Apex log files from the Salesforce platform.
This command allows you to retrieve Apex log files from a Salesforce org.
EXAMPLES
sf debug retrieve -o DeveloperEdition -u "Raffaele Preziosi" -t 10
```
## `sf debug delete`
```
USAGE
$ sf debug delete -o [--json] [-u ] [-t ] [-a]
FLAGS
-a, --all Delete log files for all users.
-o, --targetusername= (required) Username or alias of the target Salesforce org.
-t, --time= The number of minutes to retrieve log files for.
-u, --user= [default: targetusername] Username, Name, or ID of the user for whom you want to delete the logs.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Delete Apex log files from a Salesforce org.
EXAMPLES
sf debug delete -o DeveloperEdition -u "Raffaele Preziosi" -t 10
```
## `sf debuglevel new`
```
USAGE
$ sf debuglevel new -o [-n ]
FLAGS
-o, --targetusername= [required] Username or alias of the target Salesforce org.
-n, --name= [required] The developer name of the new DebugLevel.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Create a new DebugLevel.
Create a new DebugLevel assigning level for each category.
EXAMPLES
sf debuglevel new -o DeveloperEdition -n "DebugLevel"
```