October Swimmer Tools

https://www.octoberswimmer.com/tools/
Admin
A comprehensive suite of Salesforce development tools including Apex interpreter, code formatter,...
Tokens:63,405
Snippets:407
Trust Score:6.2
Update:7 months ago
Show doc for...
Tokens:
Raw
### GitHub Actions CI - Basic Setup

Source: https://www.octoberswimmer.com/tools/aer/docs/github-actions

This example demonstrates the basic setup for the aer GitHub Action in your workflow file. It checks out the code, runs the aer tests using the specified source directory, and requires a valid AER_LICENSE_KEY.

```APIDOC
## POST /.github/workflows/apex-tests.yml

### Description
This workflow file configures GitHub Actions to automatically run Apex tests using the `aer` GitHub Action on pull requests and pushes to the `main` branch.

### Method
N/A (Workflow File)

### Endpoint
N/A (Workflow File)

### Parameters
#### Action Inputs
- **source** (string) - Required - Path or paths to your Apex source directories. Defaults to `.`.
- **flags** (string) - Optional - Additional arguments passed to `aer test` (e.g., `--schema`, `--package`, `--filter`).
- **version** (string) - Optional - Pin the action to a specific `aer` release. Defaults to `latest`.

#### Environment Variables
- **AER_LICENSE_KEY** (string) - Required - Your license key for using the `aer` CLI in CI. Must be set as a repository secret.

### Request Example
```yaml
name: Apex Tests

on:
  pull_request:
  push:
    branches:
      - main

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4

      - name: Run aer tests
        uses: octoberswimmer/aer-dist@v1
        with:
          source: force-app/main/default
        env:
          AER_LICENSE_KEY: ${{ secrets.AER_LICENSE_KEY }}
```

### Response
#### Success Response (0)
Tests pass and the workflow completes successfully.

#### Response Example
Workflow logs will indicate test results. Success is indicated by the workflow completing without errors.
```

--------------------------------

### Force CLI Usage Examples

Source: https://www.octoberswimmer.com/tools/force

Demonstrates common Force CLI commands for interacting with Salesforce. These commands cover logging in, pushing metadata, executing SOQL queries, and running Apex tests. No external dependencies are required beyond the Force CLI installation.

```bash
# Log in to Salesforce
force login

# Log in to sandbox
force login -i example.sandbox.my.salesforce.com

# Push metadata
force push -t ApexClass -n MyClass

# Execute SOQL query
force query "SELECT Id, Name FROM Account LIMIT 5"

# Run Apex tests
force test MyClass_Test
```

--------------------------------

### Install and Use Thunder CLI

Source: https://www.octoberswimmer.com/tools/thunder

This snippet shows how to install the Thunder CLI, log in to Salesforce, serve a local development environment with hot reload, and deploy an application to Salesforce.

```bash
# Install Thunder CLI
go install github.com/octoberswimmer/thunder/cmd/thunder@latest

# Login to Salesforce
force login

# Serve locally with hot reload
thunder serve ./myapp

# Deploy to Salesforce
thunder deploy ./myapp --tab
```

--------------------------------

### Create and Use Local Apex Packages with aer

Source: https://www.octoberswimmer.com/tools/aer/getting-started

Package local Apex code into reusable `.pkg` files using `aer package create` and then include them in test runs with `aer test --package`. This allows for modularity and reuse of shared Apex code across different projects without installing them in an org.

```bash
cd path/to/ossc
mkdir -p packages

cd ../oslog

aer package create \
  --output ../ossc/packages/oslog.pkg \
  force-app/main/default

cd ../ossc
aer test force-app/main/default --package packages/oslog.pkg
```

```bash
aer test force-app/main/default --package-dir ./packages
```

--------------------------------

### Install and Configure force-md

Source: https://www.octoberswimmer.com/tools/force-md

Instructions for installing the force-md binary using Go and enabling shell tab completion for improved command-line usability.

```bash
go install github.com/octoberswimmer/force-md@latest

# Enable tab completion
source <(force-md completion bash)
```

--------------------------------

### Batchforce Insert Examples

Source: https://www.octoberswimmer.com/tools/batchforce/docs/batchforce_insert

Demonstrates practical examples of using the batchforce insert command. The first example uses a SOQL query to select accounts and dynamically create new ones with modified names. The second example shows inserting accounts from a CSV file. Both require valid Salesforce credentials and appropriate data.

```bash
$ batchforce insert --query "SELECT Id, Name FROM Account WHERE NOT Name LIKE '%test'" Account '{Name: record.Name + " Copy"}'
```

```bash
$ batchforce insert --file accounts.csv Account '{Name: record.Name + " Copy"}'
```

--------------------------------

### Bootstrap SQLite Data for Apex Tests

Source: https://www.octoberswimmer.com/tools/aer/getting-started

Demonstrates how to export data using the ro CLI and import it into the aer test environment. This process allows developers to use external SQLite snapshots as a source for OrgWideEmailAddress or other reference tables.

```bash
ro -D bootstrap.db OrgWideEmailAddress

aer test force-app/main/default \
  --bootstrap-db bootstrap.db \
  --bootstrap-tables OrgWideEmailAddress
```

--------------------------------

### force trace start

Source: https://www.octoberswimmer.com/tools/force/docs/force_trace_start

Sets the trace flag for a given user ID and optional flags.

```APIDOC
## force trace start

### Description
Sets the trace flag for a specified user ID.

### Method
CLI Command

### Endpoint
N/A (CLI Command)

### Parameters
#### Path Parameters
- **user id** (string) - Required - The ID of the user for whom to set the trace flag.
- **flags** (string) - Optional - Additional flags to configure the trace.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
force trace start 005xxxxxxxxxxxxxxx --json
```

### Response
#### Success Response (200)
Output indicating the trace flag has been set, or details of the trace configuration.

#### Response Example
```json
{
  "status": "success",
  "message": "Trace flag set for user 005xxxxxxxxxxxxxxx."
}
```

### Options
#### Command Specific Options
- **-h, --help** (boolean) - help for start

#### Inherited Options
- **-a, --account** (string) - account username to use
- **-V, --apiversion** (string) - API version to use
- **--config** (string) - config directory to use (default: .force)
```

--------------------------------

### Mock Managed Packages with aer

Source: https://www.octoberswimmer.com/tools/aer/getting-started

Create mock packages from installed managed packages using `aer package mock`. This allows you to include third-party code in your local test runs without needing direct access to the managed package source. The mock packages are saved as `.pkg` files.

```bash
# Export the managed package once
aer package mock dlrs \
  --account your.name@example.com \
  --output packages/dlrs.pkg

# Run tests with all package dependencies
aer test force-app/main/default \
  --package packages/oslog.pkg \
  --package packages/dlrs.pkg
```

--------------------------------

### Force CLI Login Command Examples

Source: https://www.octoberswimmer.com/tools/force/docs/force_login

Demonstrates various ways to use the 'force login' command, including specifying instance names, usernames, passwords, connected app details, and using different authentication flows like OAuth Device Flow and JWT signing.

```bash
force login
force login -i test
force login -i example--dev.sandbox.my.salesforce.com
force login -u user@example.com -p password
force login -i test -u user@example.com -p password
force login -i my-domain.my.salesforce.com -u username -p password
force login -i my-domain.my.salesforce.com -s
force login --connected-app-client-id <my-consumer-key> -u user@example.com -key jwt.key
force login --connected-app-client-id <my-consumer-key> --connected-app-client-secret <my-consumer-secret>
force login -P 8080
force login --device-flow
force login scratch
```

--------------------------------

### GitHub Actions CI - Example Workflows

Source: https://www.octoberswimmer.com/tools/aer/docs/github-actions

Provides example GitHub Actions workflows demonstrating advanced usage, such as filtering tests by name and using a matrix strategy for testing multiple source directories.

```APIDOC
## POST /.github/workflows/apex-tests.yml (Example Workflows)

### Description
These examples showcase how to leverage the `aer` GitHub Action for more specific testing scenarios, including filtering tests and parallel execution across multiple projects.

### Method
N/A (Workflow File Examples)

### Endpoint
N/A (Workflow File Examples)

### Parameters
Refer to the "Action Inputs" section for details on `source`, `flags`, and `version`.

### Request Example
#### Example 1: Filter tests by name
This workflow runs only tests that match the pattern 'Integration'.
```yaml
- name: Run integration tests
  uses: octoberswimmer/aer-dist@v1
  with:
    source: force-app/main/default
    flags: --filter Integration
  env:
    AER_LICENSE_KEY: ${{ secrets.AER_LICENSE_KEY }}
```

#### Example 2: Matrix strategy for multiple source directories
This configuration tests several independent projects in parallel by iterating through a matrix of source directories.
```yaml
jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        project:
          - force-app/main/default
          - force-app-common/main/default
          - force-app-api/main/default
    steps:
      - uses: actions/checkout@v4

      - name: Run tests for ${{ matrix.project }}
        uses: octoberswimmer/aer-dist@v1
        with:
          source: ${{ matrix.project }}
        env:
          AER_LICENSE_KEY: ${{ secrets.AER_LICENSE_KEY }}
```

### Response
#### Success Response (0)
Workflows execute as defined, with tests passing or failing according to the specified filters or project configurations.

#### Response Example
Workflow logs will detail the execution for each job or filtered test run.
```

--------------------------------

### Execute Anonymous Apex with aer

Source: https://www.octoberswimmer.com/tools/aer/getting-started

Run anonymous Apex code locally in an in-memory environment using the `aer exec` command. This is useful for experimenting with DML and SOQL without any setup or org connection, as standard objects are pre-loaded.

```bash
aer exec <<APEX
Account a = new Account(Name = 'Hello World');
insert a;
Account result = [SELECT Name FROM Account WHERE Id = :a.Id];
System.debug(result.Name);
APEX
```

--------------------------------

### Force Login Scratch Command Usage

Source: https://www.octoberswimmer.com/tools/force/docs/force_login_scratch

Examples of how to use the 'force login scratch' command with various flags to configure scratch org features, products, editions, and release versions.

```bash
force login scratch --product fsc
force login scratch --feature PersonAccounts --feature StateAndCountryPicklist
force login scratch --product fsc --quantity FinancialServicesUser=20
force login scratch --namespace myns
force login scratch --edition Enterprise --product fsc
force login scratch --setting enableEnhancedNotes
force login scratch --setting enableQuote
force login scratch --product communities
force login scratch --product healthcloud
force login scratch --release preview
force login scratch --release previous
force login scratch --duration 14
```

--------------------------------

### Force Push Command Usage

Source: https://www.octoberswimmer.com/tools/force/docs/force_push

Demonstrates basic and advanced usage of the 'force push' command for deploying metadata. It shows how to specify metadata types, individual files, and multiple metadata components by name. It also includes an example of deploying from standard input.

```bash
force push -t StaticResource -n MyResource
force push -t ApexClass
force push -f metadata/classes/MyClass.cls
force push -checkonly -test MyClass_Test metadata/classes/MyClass.cls
force push -n MyApex -n MyObject__c
git diff HEAD^ --name-only --diff-filter=ACM | force push -f -
```

--------------------------------

### Convert Salesforce Metadata Formats using force-md

Source: https://www.octoberswimmer.com/tools/force-md/docs/force-md_copy

Demonstrates how to use the force-md copy command to convert between source and metadata formats. It includes examples for basic conversion and filtered conversion using a package.xml file.

```bash
force-md copy src -t sfdx -f source      # Convert from metadata to source format
force-md copy sfdx -t src -f metadata    # Convert from source to metadata format
force-md copy src -t sfdx -f source -x package.xml  # Convert with package.xml filter
```

--------------------------------

### Migrate Attachments to ContentDocuments

Source: https://www.octoberswimmer.com/tools/batchforce/examples

Migrates legacy Attachment records to Salesforce Files (ContentVersion). It includes a mapping table for file extensions and fetches binary data via the REST API.

```bash
$ batchforce insert ContentVersion -q "SELECT ContentType, Description, Name, Id, ParentId FROM Attachment LIMIT 400000" 'let types = {
  "application/pdf" : "PDF",
  "application/msword" : "DOC",
  "application/vnd.openxmlformats-officedocument.wordprocessingml.document" : "DOCX",
  "application/vnd.ms-excel" : "XLS",
  "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" : "XLSX",
  "application/vnd.ms-powerpoint" : "PPT",
  "application/vnd.openxmlformats-officedocument.presentationml.presentation" : "PPTX",
  "text/plain" : "TXT",
  "text/csv" : "CSV",
  "text/html" : "HTML",
  "application/xml" : "XML",
  "text/xml" : "XML",
  "application/json" : "JSON",
  "image/jpeg" : "JPG",
  "image/png" : "PNG",
  "image/gif" : "GIF",
  "image/tiff" : "TIF",
  "audio/mpeg" : "MP3",
  "video/mp4" : "MP4",
  "application/zip" : "ZIP"
};
{ 
  Title: record.Name,
  Description: record.Description,
  FirstPublishLocationId: record.ParentId,
  PathOnClient: "Attachment." + types[record.ContentType] ?? "unknown",
  VersionData: base64(fetch("/services/data/v64.0/sobjects/Attachment/" + record.Id + "/Body"))
}'
```

--------------------------------

### Create Notes from Tasks via Batchforce

Source: https://www.octoberswimmer.com/tools/batchforce/examples

Converts existing Task records into ContentVersion (Notes) by mapping fields and base64 encoding the description. It uses an upsert operation with an external ID to track migrations.

```bash
batchforce upsert --external-id Migrated_From__c -b 10000 ContentVersion \
--query-all "SELECT Id, Description, CreatedDate, WhatId, CreatedBy.Name, CreatedById FROM Task WHERE Subject = 'Note' and What.Type = 'Inquiry__c' and What.RecordType.DeveloperName = 'Standard' and IsDeleted = false ORDER BY CreatedDate DESC" \
'{Title: "Note from " + record.CreatedBy.Name, FirstPublishLocationId: record.WhatId, CreatedById: record.CreatedById, CreatedDate: record.CreatedDate, PathOnClient: "Note from " + record.CreatedBy.Name + ".snote", VersionData: base64(escapeHtml(escapeUnicode(record.Description))), Migrated_From__c: record.Id}'
```

--------------------------------

### Manage Trace Flags with Force CLI

Source: https://www.octoberswimmer.com/tools/force/docs/force_trace

Provides command-line interface examples for interacting with Salesforce trace flags. Users can initiate tracing for a specific user, list existing flags, or remove them using the provided subcommands.

```bash
force trace start [user id]
force trace list
force trace delete <id>
```

--------------------------------

### Force CLI Bulk Data Operations

Source: https://www.octoberswimmer.com/tools/force/docs/force_bulk

Examples of using the 'force bulk' command to perform data operations such as insert, update, delete, and upsert using CSV files or SOQL queries with the Bulk API. It also shows how to manage jobs and batches.

```bash
force bulk insert Account [csv file]
force bulk update Account [csv file]
force bulk delete Account [csv file]
force bulk upsert -e ExternalIdField__c Account [csv file]
force bulk job [job id]
force bulk batches [job id]
force bulk batch [job id] [batch id]
force bulk query [-wait | -w] Account [SOQL]
force bulk query [-chunk | -p]=50000 Account [SOQL]
```

--------------------------------

### Start Apex Language Server Protocol Server

Source: https://www.octoberswimmer.com/tools/aer/docs/aer_lsp

Initializes the Apex LSP server, which communicates via stdin/stdout to provide IDE features. It accepts source directories and configuration flags to customize the parsing and analysis behavior.

```shell
aer lsp [source-directories...] [flags]
```

--------------------------------

### CLI Usage for p2-github-scheduler

Source: https://www.octoberswimmer.com/tools/p2/docs/manual-setup

The p2-github-scheduler CLI allows for local testing and debugging of issue scheduling. It can schedule issues from a GitHub Project, perform dry runs to preview changes, and enable debug logging for detailed output. Authentication is handled via the GITHUB_TOKEN environment variable or interactive device flow.

```bash
# Schedule issues from a GitHub Project
p2-github-scheduler https://github.com/orgs/myorg/projects/1

# Dry run (show changes without updating)
p2-github-scheduler --dry-run owner/repo

# Enable debug logging
p2-github-scheduler --debug owner/repo

```

--------------------------------

### Authenticate with Username/Password and Backup Salesforce Data with Ro (CLI)

Source: https://www.octoberswimmer.com/tools/ro/docs/quick-start

This command authenticates with Salesforce using username and password, then backs up all objects. Replace placeholders with your actual Salesforce credentials. The 'ro' CLI tool must be installed.

```bash
$ ro -e login.salesforce.com -u username@org.example.com -p passwordToken
```

--------------------------------

### Force Login Scratch Synopsis

Source: https://www.octoberswimmer.com/tools/force/docs/force_login_scratch

The base syntax for executing the scratch org creation command.

```bash
force login scratch [flags]
```

--------------------------------

### Run Apex Tests with aer

Source: https://www.octoberswimmer.com/tools/aer/getting-started

Execute Apex tests within a Salesforce DX project structure using the `aer test` command. This command automatically builds a schema by scanning metadata in the provided directories. It supports both Salesforce DX source format and the classic metadata API layout.

```bash
cd path/to/ossc
aer test force-app/main/default
```

```bash
aer test force-app/main/default force-app/extra/default
```

```bash
# Classic metadata format
aer test src
```

--------------------------------

### Format Apex and SOQL using apexfmt CLI

Source: https://www.octoberswimmer.com/tools/apexfmt

Demonstrates various command-line operations for apexfmt, including file formatting, in-place overwriting, listing unformatted files, and processing SOQL queries via standard input.

```bash
# Format file to stdout
apexfmt MyClass.cls

# Format and overwrite files
apexfmt -w *.cls *.trigger

# Check which files need formatting
apexfmt -l sfdx/main/default/classes/*.cls

# Format SOQL query
echo "SELECT Id, Name FROM Account WHERE Type = 'Customer'" | apexfmt -s

# Format from stdin
cat MyClass.cls | apexfmt
```

--------------------------------

### Fetch Salesforce Metadata using Force CLI

Source: https://www.octoberswimmer.com/tools/force/docs/force_fetch

Demonstrates how to use the force fetch command to retrieve metadata. Users can specify metadata types, individual component names, or a package.xml file to define the scope of the export.

```bash
force fetch -t=CustomObject -n=Book__c -n=Author__c
force fetch -t Aura -n MyComponent -d /Users/me/Documents/Project/home
force fetch -t AuraDefinitionBundle -t ApexClass
force fetch -x myproj/metadata/package.xml
```

--------------------------------

### Force REST GET

Source: https://www.octoberswimmer.com/tools/force/docs/force_rest_get

Executes a REST GET request to a specified URL. Supports various flags for account, API version, and URL handling.

```APIDOC
## POST /tooling/query

### Description
Execute a REST GET request to the specified URL.

### Method
GET

### Endpoint
`/tooling/query?q={SOQL_QUERY}`

### Parameters
#### Query Parameters
- **q** (string) - Required - The SOQL query to execute.

#### Options
- **-h, --help** - help for get
- **-a, --account** (string) - Optional - Account username to use.
- **-V, --apiversion** (string) - Optional - API version to use.
- **-A, --absolute** - Optional - Use URL as-is (do not prepend /services/data/vXX.0).

### Request Example
```bash
force rest get "/tooling/query?q=Select id From Account"
force rest get /appMenu/AppSwitcher
force rest get -a myuser@example.com -V 58.0 /services/data/
```

### Response
#### Success Response (200)
- **result** (object) - The result of the REST GET request.
- **status** (integer) - The HTTP status code of the response.

#### Response Example
```json
{
  "result": {
    "totalSize": 1,
    "done": true,
    "records": [
      {
        "attributes": {
          "type": "Account"
        },
        "Id": "001xxxxxxxxxxxx"
      }
    ]
  },
  "status": 200
}
```
```

--------------------------------

### Service Class Example

Source: https://www.octoberswimmer.com/tools/aer/docs/mock-managed-package-classes

An example Apex service class that uses `oslog.Log` to write audit events. This class is used to demonstrate how to stub the logger for testing purposes.

```apex
public with sharing class BillingService {
    public static void invoice(Id orderId) {
        oslog.Log.info('Invoicing order ' + orderId);
        // ... remainder of the implementation ...
    }
}
```

--------------------------------

### View force-md queue command help

Source: https://www.octoberswimmer.com/tools/force-md/docs/force-md_queue

Displays the help information for the queue command, including available flags and inherited options for managing Salesforce metadata queues.

```bash
force-md queue --help
```

--------------------------------

### Force CLI Login Command Options

Source: https://www.octoberswimmer.com/tools/force/docs/force_login

Lists the available options for the 'force login' command, including API version, instance targeting, user credentials, connected app details, and authentication flow specific flags.

```bash
force login [flags]

Options:
  -v, --api-version string                   API version to use
      --connected-app-client-id string       Client Id (aka Consumer Key) to use instead of default
      --connected-app-client-secret string   Client Secret (aka Consumer Secret) for Client Credentials flow
      --device-flow                          use OAuth Device Flow (for headless environments)
  -h, --help                                 help for login
  -i, --instance string                      Defaults to 'login' or last
                                             logged in system. non-production server to login to (values are 'pre',
                                             'test', or full instance url
  -k, --key string                           JWT signing key filename
  -p, --password string                      password for SOAP login
  -P, --port int                             port for local OAuth callback server (default 3835)
  -s, --skip                                 skip login if already authenticated and only save token (useful with SSO)
  -u, --user string                          username for SOAP login

Options inherited from parent commands:
  -a, --account username    account username to use
  -V, --apiversion string   API version to use
      --config string       config directory to use (default: .force)
```

--------------------------------

### Force Record Get Command Usage (CLI)

Source: https://www.octoberswimmer.com/tools/force/docs/force_record_get

This snippet shows the command-line syntax for the 'force record get' command. It requires the object type and the record ID as arguments. Options for help and account/API version are also available.

```bash
force record get <object> <id>

Options:
  -h, --help   help for get

Options inherited from parent commands:
  -a, --account username    account username to use
  -V, --apiversion string   API version to use
      --config string       config directory to use (default: .force)
```

--------------------------------

### POST force oauth create

Source: https://www.octoberswimmer.com/tools/force/docs/force_oauth_create

Creates a new ConnectedApp using the specified name and callback URL.

```APIDOC
## POST force oauth create

### Description
Creates a new ConnectedApp to manage OAuth credentials within the Force CLI environment.

### Method
POST

### Endpoint
force oauth create <name> <callback> [flags]

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the ConnectedApp to create.
- **callback** (string) - Required - The OAuth callback URL.

#### Query Parameters
- **--account** (string) - Optional - Account username to use.
- **--apiversion** (string) - Optional - API version to use.
- **--config** (string) - Optional - Config directory to use (default: .force).

### Request Example
force oauth create MyApp http://localhost:3835/oauth/callback

### Response
#### Success Response (200)
- **status** (string) - Confirmation of ConnectedApp creation.

#### Response Example
{
  "status": "success",
  "message": "ConnectedApp 'MyApp' created successfully."
}
```

--------------------------------

### Create ConnectedApp via Force CLI

Source: https://www.octoberswimmer.com/tools/force/docs/force_oauth_create

This command initializes a new ConnectedApp in the Salesforce environment. It requires a name and a callback URL as positional arguments, with optional flags for account and API version configuration.

```bash
force oauth create <name> <callback> [flags]
```

```bash
force oauth create MyApp http://localhost:3835/oauth/callback
```

--------------------------------

### GET /force/field/list

Source: https://www.octoberswimmer.com/tools/force/docs/force_field_list

Lists all fields associated with a specific SObject in the Salesforce environment.

```APIDOC
## GET force field list

### Description
Retrieves a list of all fields for a specified SObject.

### Method
CLI Command (GET equivalent)

### Endpoint
force field list <object>

### Parameters
#### Path Parameters
- **object** (string) - Required - The name of the SObject to retrieve fields for.

#### Query Parameters
- **-a, --account** (string) - Optional - Account username to use.
- **-V, --apiversion** (string) - Optional - API version to use.
- **--config** (string) - Optional - Config directory to use (default: .force).

### Request Example
force field list Account --account myuser@example.com

### Response
#### Success Response (200)
- **fields** (array) - A list of field objects containing field metadata.

#### Response Example
{
  "fields": [
    {"name": "Id", "type": "id"},
    {"name": "Name", "type": "string"}
  ]
}
```

--------------------------------

### GET force-md sharingrules owner list

Source: https://www.octoberswimmer.com/tools/force-md/docs/force-md_sharingrules_owner_list

Lists workflow rules for owner-based sharing configurations.

```APIDOC
## GET force-md sharingrules owner list

### Description
Lists all owner-based sharing rules defined in the specified metadata files.

### Method
GET

### Endpoint
force-md sharingrules owner list [flags] [filename]...

### Parameters
#### Path Parameters
- **filename** (string) - Optional - The path to the metadata file(s) to process.

#### Query Parameters
- **-h, --help** (boolean) - Optional - Show help for the list command.
- **--convert-xml-entities** (boolean) - Optional - Convert numeric xml entities to character entities (default: true).
- **--silent** (boolean) - Optional - Show errors only.
- **--verbose** (boolean) - Optional - Show debugging output.

### Request Example
force-md sharingrules owner list --verbose sharing_rules.xml

### Response
#### Success Response (200)
- **output** (string) - A list of owner-based sharing rules extracted from the provided files.

#### Response Example
{
  "status": "success",
  "rules": [
    {
      "fullName": "Example_Sharing_Rule",
      "sharedTo": "AllInternalUsers"
    }
  ]
}
```

--------------------------------

### force-md package add command options

Source: https://www.octoberswimmer.com/tools/force-md/docs/force-md_package_add

Lists the available flags for the add command, including help, metadata name, and metadata type.

```text
  -h, --help          help for add
  -n, --name string   metadata item name
  -t, --type string   metadata type
```

--------------------------------

### GET /permissionset/field-permissions/list

Source: https://www.octoberswimmer.com/tools/force-md/docs/force-md_permissionset_field-permissions_list

Lists all field permissions defined in the provided permission set XML files.

```APIDOC
## GET force-md permissionset field-permissions list

### Description
Lists the field permissions contained within the specified permission set file(s).

### Method
CLI Command

### Endpoint
force-md permissionset field-permissions list [filename]...

### Parameters
#### Path Parameters
- **filename** (string) - Required - The path to the permission set XML file(s) to process.

#### Options
- **-h, --help** (flag) - Optional - Display help for the list command.
- **--convert-xml-entities** (boolean) - Optional - Convert numeric xml entities to character entities (default: true).
- **--silent** (boolean) - Optional - Show errors only.
- **--verbose** (boolean) - Optional - Show debugging output.

### Request Example
force-md permissionset field-permissions list my-permission-set.permissionset-meta.xml

### Response
#### Success Response (0)
- **output** (string) - A list of field permissions found in the specified file(s).

#### Response Example
{
  "fields": [
    {
      "field": "Account.CustomField__c",
      "readable": true,
      "editable": true
    }
  ]
}
```

--------------------------------

### force-md command options

Source: https://www.octoberswimmer.com/tools/force-md/docs/force-md_permissionset_custom-metadata_add

Lists the available flags for the add command, including help and the required type definition.

```bash
  -h, --help          help for add
  -t, --type string   custom metadata type
```

--------------------------------

### GET /objects/fields/show

Source: https://www.octoberswimmer.com/tools/force-md/docs/force-md_objects_fields_show

Displays detailed information about a specific field within a Salesforce object metadata file.

```APIDOC
## GET objects fields show

### Description
Displays the metadata details for a specific field within the provided object metadata file(s).

### Method
CLI Command (force-md objects fields show)

### Endpoint
force-md objects fields show -f [field] [filename]...

### Parameters
#### Path Parameters
- **filename** (string) - Required - The path to the object metadata file(s).

#### Query Parameters
- **-f, --field** (string) - Required - The name of the field to display.
- **-m, --formula** (boolean) - Optional - If set, shows the formula only.
- **-h, --help** (boolean) - Optional - Displays help information for the command.

### Options inherited from parent commands
- **--convert-xml-entities** (boolean) - Optional - Convert numeric xml entities to character entities (default true).
- **--silent** (boolean) - Optional - Show errors only.
- **--verbose** (boolean) - Optional - Show debugging output.

### Request Example
force-md objects fields show -f MyField__c Account.object

### Response
#### Success Response (200)
- **field_metadata** (object) - The metadata definition of the requested field.

#### Response Example
{
  "fullName": "MyField__c",
  "label": "My Field",
  "type": "Text",
  "length": 255
}
```

--------------------------------

### Debug Console Expressions

Source: https://www.octoberswimmer.com/tools/aer/docs/interactive-debugging

Examples of expressions that can be evaluated in the VS Code Debug Console during an active debugging session to inspect state.

```apex
sum
Test.isRunningTest()
accounts[0].Name
```

--------------------------------

### GET /custommetadata/table

Source: https://www.octoberswimmer.com/tools/force-md/docs/force-md_custommetadata_table

Lists custom metadata records from specified files in a table format, supporting filtering and field selection.

```APIDOC
## CLI COMMAND: force-md custommetadata table

### Description
Lists custom metadata records in a table format based on provided file paths. Supports filtering expressions and specific field selection.

### Method
CLI Command

### Endpoint
force-md custommetadata table [flags] [filename]...

### Parameters
#### Path Parameters
- **filename** (string) - Required - Path to the customMetadata XML files.

#### Options
- **-i, --fields** (stringArray) - Optional - Field(s) to include in the output table.
- **-f, --filter** (string) - Optional - Boolean expression to filter records (default: "true").
- **-h, --help** (boolean) - Optional - Display help information for the command.

#### Inherited Options
- **--convert-xml-entities** (boolean) - Optional - Convert numeric XML entities to character entities (default: true).
- **--silent** (boolean) - Optional - Show errors only.
- **--verbose** (boolean) - Optional - Show debugging output.

### Request Example
$ force-md custommetadata table -f 'dlrs__CalculationMode__c != "Realtime"' src/customMetadata/dlrs__LookupRollupSummary2.*

### Response
#### Success Response
- **Table Output** (text) - A formatted table displaying the requested metadata fields and records.
```

--------------------------------

### Force CLI Bulk Command Options

Source: https://www.octoberswimmer.com/tools/force/docs/force_bulk

Displays the help information for the 'force bulk' command, including its own options and inherited options from parent commands like account and API version.

```bash
force bulk -h

Options:
  -h, --help   help for bulk

Options inherited from parent commands:
  -a, --account username    account username to use
  -V, --apiversion string   API version to use
      --config string       config directory to use (default: .force)
```

--------------------------------

### Populate Field from Opportunity History

Source: https://www.octoberswimmer.com/tools/batchforce/examples

Identifies the user who last moved an Opportunity to 'Closed Lost' by querying the OpportunityHistory sub-query and updating a custom field.

```bash
$ batchforce update Opportunity \
  -q "SELECT Id, (SELECT CreatedById, NewValue FROM Histories WHERE Field = 'StageName' ORDER BY CreatedDate DESC) from Opportunity WHERE StageName = 'Closed Lost'" \
  'let history = record.Histories ?? []; let update = filter(history, #.NewValue == "Closed Lost") | first(); update == nil ? nil : {Id: record.Id, Closed_By__c: update.CreatedById}'
```

--------------------------------

### force-md command options

Source: https://www.octoberswimmer.com/tools/force-md/docs/force-md_application_tab_add

Lists the available flags for the add command and the global flags inherited from parent commands, such as XML entity conversion and verbosity settings.

```bash
  -h, --help         help for add
  -t, --tab string   tab name
```

```bash
      --convert-xml-entities   convert numeric xml entities to character entities (default true)
      --silent                 show errors only
      --verbose                show debugging output
```

--------------------------------

### POST /package/add

Source: https://www.octoberswimmer.com/tools/force-md/docs/force-md_package_add

Adds a metadata item to the package.xml file by specifying the type and name of the component.

```APIDOC
## POST /package/add

### Description
Adds a metadata item to the package.xml file. This command updates the manifest to include the specified metadata type and name.

### Method
POST

### Endpoint
/package/add

### Parameters
#### Query Parameters
- **type** (string) - Required - The metadata type (e.g., ApexClass, CustomObject).
- **name** (string) - Required - The name of the metadata item.

#### Request Body
- **filenames** (array) - Optional - List of specific filenames to include.

### Request Example
{
  "type": "ApexClass",
  "name": "MyController"
}

### Response
#### Success Response (200)
- **status** (string) - Confirmation message of the addition.

#### Response Example
{
  "status": "success",
  "message": "Added ApexClass: MyController to package.xml"
}
```

--------------------------------

### Format Timezone-Aware Date Fields

Source: https://www.octoberswimmer.com/tools/batchforce/examples

Calculates and formats day of the week and hour from CreatedDate based on a division-specific timezone. It updates Lead records with these derived values.

```bash
$ batchforce update Lead -q "SELECT Id, CreatedDate, Division__r.Time_Zone__c FROM Lead WHERE Created_Day__c = null" \
 'let t = date(record.CreatedDate, "2006-01-02T15:04:05.000-0700").In(timezone(record.Division__r.Time_Zone__c));
  let day = "0" + string(int(t.Weekday()) + 1) + "-" + t.Format("Mon");
  {Id: record.Id, Created_Day__c: day, Created_Hour__c: a.Format("15")}'
```

--------------------------------

### Update User Roles with Apex Context

Source: https://www.octoberswimmer.com/tools/batchforce/examples

Updates user roles by executing anonymous Apex to fetch a Role ID and injecting it into the Batchforce expression context.

```bash
$ batchforce update User --context "Id newRoleId = [SELECT Id FROM UserRole WHERE DeveloperName = 'New_Role'].Id;" \
  -q "SELECT Id FROM User WHERE UserRole.DeveloperName = 'Old_Role'" \
  '{Id: record.Id, UserRoleId: apex.newRoleId}'
```

--------------------------------

### Initialize aer Debugger

Source: https://www.octoberswimmer.com/tools/aer/docs/interactive-debugging

Command to initialize the interactive debugger for Apex tests. This command installs the necessary VS Code extension and generates the required launch configuration.

```bash
aer test --debug force-app/main/default/classes
```

--------------------------------

### force login scratch

Source: https://www.octoberswimmer.com/tools/force/docs/force_login_scratch

Creates a Salesforce scratch org and logs the user in. This command allows for extensive customization of the scratch org through various flags.

```APIDOC
## POST /force/login/scratch

### Description
Creates a Salesforce scratch org and logs the user in. This command allows for extensive customization of the scratch org through various flags, including features, products, editions, settings, and release preferences.

### Method
POST

### Endpoint
/force/login/scratch

### Parameters
#### Query Parameters
- **product** (string) - Optional - Product shortcut for features (can be specified multiple times). Examples: communities, fsc, healthcloud.
- **feature** (string) - Optional - Feature to enable (can be specified multiple times). Examples: Communities, ContactsToMultipleAccounts, FinancialServicesUser, HealthCloudAddOn, HealthCloudUser, ApexUserModeWithPermset, EventLogFile, PersonAccounts, StateAndCountryPicklist.
- **quantity** (stringToString) - Optional - Override default quantity for features (e.g., FinancialServicesUser=5). Default quantity is 10.
- **edition** (string) - Optional - Scratch org edition. Available editions: Developer (default), Enterprise, Group, Professional, PartnerDeveloper, PartnerEnterprise, PartnerGroup, PartnerProfessional.
- **setting** (string) - Optional - Setting to enable (can be specified multiple times). Examples: enableEnhancedNotes, enableQuote, networksEnabled, enableApexApprovalLockUnlock, permsetsInFieldCreation.
- **release** (string) - Optional - Salesforce release for scratch org: preview (next release) or previous.
- **duration** (int) - Optional - Number of days before the scratch org expires (1-30). Default is 7.
- **namespace** (string) - Optional - Namespace for the scratch org.
- **username** (string) - Optional - Username for the scratch org user.
- **account** (string) - Optional - Account username to use (inherited from parent command).
- **apiversion** (string) - Optional - API version to use (inherited from parent command).
- **config** (string) - Optional - Config directory to use (default: .force) (inherited from parent command).

### Request Example
```json
{
  "product": "fsc",
  "feature": ["PersonAccounts", "StateAndCountryPicklist"],
  "quantity": {
    "FinancialServicesUser": "20"
  },
  "edition": "Enterprise",
  "setting": ["enableEnhancedNotes", "enableQuote"],
  "release": "preview",
  "duration": 14,
  "namespace": "myns",
  "username": "testuser@example.com",
  "account": "myaccount@example.com",
  "apiversion": "58.0",
  "config": ".myconfig"
}
```

### Response
#### Success Response (200)
- **orgId** (string) - The ID of the created scratch org.
- **username** (string) - The username of the created scratch org user.
- **loginUrl** (string) - The URL to log into the scratch org.

#### Response Example
```json
{
  "orgId": "00Dxxxxxxxxxxxx",
  "username": "testuser@example.com.dev",
  "loginUrl": "https://your-domain.my.salesforce.com"
}
```
```

--------------------------------

### Sync Opportunity Field to Account via Batchforce

Source: https://www.octoberswimmer.com/tools/batchforce/examples

Copies a URL field from the most recent Opportunity to the parent Account record. It uses a conditional expression to ensure only the first record per account is processed.

```bash
$ batchforce update Account -q "SELECT Id, URL__c, Account.URL__c, AccountId FROM Opportunity WHERE URL__c != null AND Account.URL = null ORDER BY AccountId, CreatedDate desc" \
'incr(record.AccountId) > 1 ? nil : {Id: record.AccountId, URL__c: record.URL__c}'
```

--------------------------------

### POST /application/tab/add

Source: https://www.octoberswimmer.com/tools/force-md/docs/force-md_application_tab_add

Adds tab visibility settings to a specified Salesforce application metadata file.

```APIDOC
## POST force-md application tab add

### Description
Adds tab visibility to a Salesforce application metadata file. This command modifies the XML structure to include the specified tab.

### Method
POST

### Endpoint
force-md application tab add -t [TabName] [filename]

### Parameters
#### Path Parameters
- **filename** (string) - Required - The path to the application metadata file.

#### Query Parameters
- **-t, --tab** (string) - Required - The name of the tab to add.

#### Request Body
- **--convert-xml-entities** (boolean) - Optional - Convert numeric xml entities to character entities (default: true).
- **--silent** (boolean) - Optional - Show errors only.
- **--verbose** (boolean) - Optional - Show debugging output.

### Request Example
force-md application tab add -t MyCustomTab application.app

### Response
#### Success Response (200)
- **status** (string) - Confirmation that the tab was added successfully to the metadata file.

#### Response Example
{
  "message": "Tab MyCustomTab added successfully to application.app"
}
```

--------------------------------

### force-md package new

Source: https://www.octoberswimmer.com/tools/force-md/docs/force-md_package_new

Creates a new package.xml file. You can specify the filename as an argument.

```APIDOC
## force-md package new

### Description
Creates a new package.xml file. You can specify the filename as an argument.

### Method
CLI Command

### Endpoint
N/A (CLI Command)

### Parameters
#### Path Parameters
- **filename** (string) - Required - The name of the package.xml file to create.

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
force-md package new myPackage.xml
```

### Response
#### Success Response
Creates a new file named `myPackage.xml` in the current directory.

#### Response Example
(No direct response body, file is created on the filesystem)
```

--------------------------------

### Freeze Salesforce Users via Batchforce

Source: https://www.octoberswimmer.com/tools/batchforce/examples

Updates UserLogin records to freeze users based on their profile names. It uses a SOQL query to identify target users and sets the IsFrozen flag to true.

```bash
$ batchforce update UserLogin -q "SELECT Id FROM UserLogin WHERE UserId IN (SELECT Id FROM User WHERE Profile.Name IN ('Marketing', 'Customer Support'))" '{Id: record.Id, IsFrozen: true}'
```

--------------------------------

### Advanced Workflow Patterns: Filtering and Matrix Strategy

Source: https://www.octoberswimmer.com/tools/aer/docs/github-actions

Examples for running specific tests using filters and executing tests across multiple projects in parallel using a matrix strategy.

```yaml
# Filter by name
- name: Run integration tests
  uses: octoberswimmer/aer-dist@v1
  with:
    source: force-app/main/default
    flags: --filter Integration
  env:
    AER_LICENSE_KEY: ${{ secrets.AER_LICENSE_KEY }}

# Matrix strategy
jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        project:
          - force-app/main/default
          - force-app-common/main/default
          - force-app-api/main/default
    steps:
      - uses: actions/checkout@v4
      - name: Run tests for ${{ matrix.project }}
        uses: octoberswimmer/aer-dist@v1
        with:
          source: ${{ matrix.project }}
        env:
          AER_LICENSE_KEY: ${{ secrets.AER_LICENSE_KEY }}
```

--------------------------------

### Inherited Parent Command Options

Source: https://www.octoberswimmer.com/tools/force/docs/force_bulk_update

Global configuration flags inherited from the parent force command, used to specify account credentials, API versions, and configuration directories.

```shell
-a, --account username    account username to use
-V, --apiversion string   API version to use
    --config string       config directory to use (default: .force)
```

--------------------------------

### Update Salesforce records using batchforce

Source: https://www.octoberswimmer.com/tools/batchforce/docs/batchforce_update

Demonstrates how to use the batchforce update command to modify Salesforce records. The examples show both simple field concatenation and complex updates using anonymous Apex for context mapping.

```bash
batchforce update --query "SELECT Id, Name FROM Account WHERE NOT Name LIKE '%test'" Account '{Id: record.Id, Name: record.Name + " Test"}'

batchforce update --query "SELECT Id, Type__c FROM Account WHERE RecordType.DeveloperName = 'OldValue'" Account '{Id: record.Id, RecordTypeId: apex.recordTypes[record.Type__c]}' --context "Map<String, Id> recordTypes = new Map<String, Id>(); for (RecordType r : [SELECT DeveloperName, Id FROM RecordType WHERE SobjectType = 'Account']){ recordTypes.put(r.DeveloperName, r.Id); }"
```

--------------------------------

### Force CLI Command Options

Source: https://www.octoberswimmer.com/tools/force/docs/force_sobject_delete

Lists the available flags for the delete operation, including help documentation and inherited global configuration flags for account management and API versioning.

```bash
# Command specific options
-h, --help

# Inherited options
-a, --account username
-V, --apiversion string
--config string
```
Tokens:
Raw