skuid CLI¶

macOS and Linux¶

If you have curl, grep and awk in your environment, you can quickly install the application via the command line:

# macOS:
curl -Lo skuid https://github.com/skuid/skuid-cli/releases/latest/download/skuid_darwin_amd64
# Linux:
curl -Lo skuid https://github.com/skuid/skuid-cli/releases/latest/download/skuid_linux_amd64

# Give the skuid application the permissions it needs to run
chmod +x skuid

# Move the skuid application to a folder where it can be used easily,
# for example, a directory in your $PATH.
# Enter your computer account password if prompted
sudo mv skuid /usr/local/bin/skuid

To manually install the application, follow these steps:

1. Download the latest release of the skuid application binary.

2. Navigate to the directory containing the skuid binary file in a terminal application.

   cd /path/to/the/downloaded/binary
   

3. Rename the downloaded application binary file to skuid:

   # macOS:
   mv skuid_darwin_amd64 skuid
   # Linux:
   # mv skuid_linux_amd64 skuid
   

4. Give the application executable permissions:

   chmod +x skuid
   

5. Ensure the binary is accessible in your $PATH variable. This can be done one of two ways:

   • Move the application to a folder that’s already in your $PATH variable, like /usr/local/bin

     mv skuid /usr/local/bin/skuid
     

   • Add the application’s folder to the PATH variable:

     # This method doesn't require moving the `skuid` binary, which may be not be possible depending on user permissions.
     # The location of the `skuid` binary isn't important in this use case, but try to store it in a folder it's unlikely to move from.
     
     # This example assumes the `skuid` binary is located in ~/Documents/Skuid
     export PATH=$PATH:~/Documents/Skuid
     

   Note

   If you choose to update your shell profile you’ll need to source your shell profile or restart your session for those changes to take effect.

6. Verify that you can run the application:

   skuid --help
   

Windows¶

1. Download the latest Windows executable release in your web browser.

2. (Optional) Move the executable to a more permanent location, such as C:\Program Files\Skuid\.

3. (Optional) Set an alias to easily access the executable.

   In Windows Powershell, use Set-Alias. For information about saving aliases in Powershell, see Microsoft documentation

   Set-Alias skuid C:\Path\To\skuid_windows_amd64.exe
   

   In the Windows Command Prompt, use doskey. For information about saving doskey aliases for future sessions, see Microsoft documentation.

   doskey skuid=C:\Path\To\skuid_windows_amd64.exe
   

4. Invoke the executable by typing its name or alias and pressing enter: skuid --help.

Using go¶

Use the the Go programming language? If so, you can also install skuid by running go get github.com/skuid/skuid-cli.

Upgrading skuid CLI¶

To upgrade skuid, first remove the previous version’s binary:

# Use the rm command with the appropriate path to the skuid binary
# For example, if the binary is installed in /usr/local/bin:
rm /usr/local/bin/skuid

After removing the previous version, repeat the installation steps listed above.

Skuid NLX¶

export SKUID_UN='username'
export SKUID_PW='password'
export SKUID_HOST='https://example.skuidsite.com'

Set-Item Env:SKUID_UN 'username'
Set-Item Env:SKUID_PW 'password'
Set-Item Env:SKUID_HOST 'https://example.skuidsite.com'

Set SKUID_UN=username
Set SKUID_PW=password
Set SKUID_HOST=https://example.skuidsite.com

Skuid SFX¶

Note that the SKUID_PW in this case must be a user’s Salesforce password directly connected to the user’s Salesforce security token.

So with AMostExcellentPassword as a password and aBc12dEF34gh56ij7k as a security token, the SKUID_PW would be set to:

AMostExcellentPasswordaBc12dEF34gh56ij7k

export SKUID_UN='username'
export SKUID_PW='password + salesforce-security-token'
export SKUID_HOST='https://my-domain.my.salesforce.com'
export SKUID_CLIENT_ID='connected-app-consumer-key'
export SKUID_CLIENT_SECRET='connected-app-consumer-secret'

Set-Item Env:SKUID_UN 'username'
Set-Item Env:SKUID_PW 'password + salesforce-security-token'
Set-Item Env:SKUID_HOST 'https://my-domain.my.salesforce.com'
Set-Item Env:SKUID_CLIENT_ID 'connected-app-consumer-key'
Set-Item Env:SKUID_CLIENT_SECRET 'connected-app-consumer-secret'

Set SKUID_UN=username
Set SKUID_PW=password + salesforce-security-token
Set SKUID_HOST=https://my-domain.my.salesforce.com
Set SKUID_CLIENT_ID=connected-app-consumer-key
Set SKUID_CLIENT_SECRET=connected-app-consumer-secret

Commands¶

The commands used to accomplish this depend on the platform of choice:

• When using Skuid NLX:
  • retrieve retrieves metadata from a Skuid NLX site.
  • deploy sends metadata to a Skuid NLX site.
  • watch listens for changes to local metadata files and sends changes to a Skuid NLX site.
• When using Skuid SFX:
  • pull retrieves Skuid pages from the Salesforce org.
    • Can be used with the --module flag to pull one or more specified modules.
  • push sends all Skuid pages within current directory to the Salesforce org.
    • Can be used with the --file flag to push a specific Skuid page.
    • Can be used with the --module flag to specify which module the page(s) should be added to. If no module is specified, then the page(s) will not be added to any module.
  • page-pack retrieves Skuid pages from the Salesforce org as a page pack.
    • Requires the --output flag.
    • Can be used with the --module flag to pull one or more specified modules.

Command Flags¶

• Authentication and Platform: These flags can be used when authenticating to either platform in lieu of exporting environment variables.

  • --host: (string) The Skuid host platform’s base URL, e.g. https://example.skuidsite.com for Skuid NLX or https://my-domain.my.salesforce.com for SFX
  • --password: (string) Skuid NLX / Salesforce Password
    • Abbreviated form: -p
  • --username: (string) Skuid NLX / Salesforce Username
    • Abbreviated form: -u
  • --client-id (string): Skuid SFX only. The consumer ID for the Salesforce connected app.
  • --client-secret (string): Skuid SFX only. The consumer secret for the Salesforce connected app.
  • --dataServiceProxy (string): The IP or URI through which traffic should be routed to reach a Skuid site’s data services. May be necessary for cases where skuid CLI is executed from a machine on an internal network and VPN rules require proxy use.
  • --metadataServiceProxy (string): The IP or URI through which traffic should be routed to reach a Skuid site’s metadata service. May be necessary for cases where skuid CLI is executed from a machine on an internal network and VPN rules require proxy use.

• Data management:

  • --dir: (string) The input/output directory where files are retrieved and stored to or deployed from.

    • Abbreviated form: -d

  • --module: (string) Skuid SFX only. One or more Skuid page modules, separated by commas, to deploy or retrieve.

    • Abbreviated form: -m

  • --no-module: (string) Skuid SFX only. Indicates that skuid should pull all pages that are not included in a module. May be used in conjunction with the --module flag to also pull pages from modules during the same pull action.

    Does not apply to the push command.

  • --page: (string) Skuid SFX only. One or more Skuid pages, listed by page name and separated by commas, to retrieve to the local file system.

    • Abbreviated form: -n

• Debugging:

  • --verbose: When used, skuid displays all possible logging information.
    • Abbreviated form: -v

• Command-specific:

  • --file: (string) Used with skuid push to push a specific Skuid page to a Salesforce org. Must point to a page’s .json file, not its .xml file. Even though edits are made to a page’s .xml file, this flag will only work if it points to the .json file.
    • Abbreviated form: -f
  • --output: (string) Used with skuid page-pack to set the filename of the created page pack.
    • Abbreviated form: -o

  It is also possible to use the --api-version flag to select which version of the deployment API to use, however it does not have much use as only version 1 is active at this time.

Examples¶

What Is Not Retrieved by skuid¶

• Created by and Modified by metadata for pages
  • When deploying Skuid pages to a site, the created/modified by user and date matches the identity of whoever is running the deployment, as well as the time and date of the deployment.
• Skuid NLX:
  • Authentication provider credentials
    • You must re-enter any client ID and client secret pairs on all Skuid authentication providers in the target site, even if those authentication providers already existed.
  • Users and user data for Skuid NLX
    • While user profiles are transferred, individual user accounts and their information are not. Users must be manually re-created—or provisioned through single sign-on—for at least the first deployment.

Version control¶

Retrieving Skuid data objects for local storage allows for the use of version control systems, such as git.

For example, you could create a directory for your Skuid site and initiate a git repository:

mkdir my-skuid-site
cd my-skuid-site
git init

After exporting the proper Skuid authentication credentials, you could retrieve and commit Skuid data within that git repo:

skuid retrieve
git add -A
git commit -m 'Initial commit of Skuid site'

With a workflow like this, it’s easier to capture snapshots of Skuid sites at certain points in time, allowing for both easy rollbacks (should issues arise) as well as developer collaboration on these Skuid objects. For a more in-depth tutorial, see Version Control with Salesforce - A Primer.

Sandboxes¶

skuid is particularly useful for moving Skuid data from a sandbox—or testing space—to production for end-users. Whether that be Skuid SFX—which takes some additional deployment steps—or the nearly complete transferral possible for Skuid NLX sites.

The -u, -p and --host flags can be used to temporarily set different authentication and platform settings.

For example, consider a workflow like below:

# Set the authentication credentials for the sandbox site, assuming they are not set already
export SKUID_UN='{sandbox-username}'
export SKUID_PW='{sandbox-password}'
export SKUID_HOST='{https://example-sandbox.skuidsite.com}'
# Retrieve sandbox data
skuid retrieve
# Deploy sandbox data to production by temporarily using different credentials
skuid deploy -u production-username -p production-password  --host https://production-sandbox.skuidsite.com}

Consider automating this process using shell scripts. Experiment to find the workflow that best suits your lifecycle management processes.