skuid/skuid-cli

A command line application for interacting with Skuid Pages.

skuid CLI

skuid CLI is a command line interface for deploying and retrieving Skuid metadata between environments.

This repository's main branch currently represents the in-progress development of the next major release of the project.

To download binaries for the current stable release, see this repository's releases page.

To read documentation for the current stable release, see the Skuid docs site.

Local testing

To retrieve/deploy using a branch of skuid CLI, run the command in the root of this directory with go run main.go prepended. For example:

Retrieve

To retrieve run go run main.go retrieve --host='site.pliny.webserver' -d /directory -u='user' -p='pass' -v To get more information about retrieve flags, use go run main.go retrieve --help

Deploy

To deploy run go run main.go deploy --host='site.pliny.webserver' -d /directory -u='user' -p='pass' -v To get more information about deploy flags, use go run main.go deploy --help

skuid-cli's Issues

skuid with -v flag reports login was successful when it was not.

While retrieving and deploying to a few different Skuid sites, I didn't update my password env var. When I ran skuid retrieve I got the expected Error retrieving metadata: Error making HTTP request%!(EXTRA string=401 Unauthorized) message.

However I ran skuid retrieve -v just to double check, and it said that I had successfully logged in:

Logging in to Skuid Platform...
Host: {my-skuid-site}
Username: {username}
Password: {incorrect-password}
API Version: 1
Login successful! Access Token:
Retrieving metadata...
Error retrieving metadata:  Error making HTTP request%!(EXTRA string=401 Unauthorized)

For the sake of accurate debugging, the app should correctly report whether or not login was successful.

README: rename "skuid" directory to "skuid-cli".

Rename to bolded on README & https://docs.skuid.com/latest/en/skuid/cli/
README: wget https://github.com/skuid/skuid-cli/releases/download/3/skuid_darwin_amd64 -O skuid

Docs: wget $(curl https://api.github.com/repos/skuid/skuid-cli/releases/latest | grep browser_download_url | grep darwin | awk -F '"' '{print $4}') -O skuid

When using non-production org (sandbox), actions fail with no valid error message.

If using skuid to interact with a Sandbox org, interactions fail with a strange, non intuitive error message.

skuid should make sure it gets a valid AccessToken from the force.Login method and output an error message if it doesn't get one.

skuid cli not pulling all pages

Hello I just configured the skuid cli for a new client sandbox.

1. skuid pull -v
   Pages written to skuidpages

2. no errors echo $?
   0

There are over 80 pages in the org and I'm only getting 10 pages back. I noticed that the pages I'm getting back are pages where I'm the owner. So I changed the owner of a few other pages and I'm still getting the same set of 10 pages back.

I've used the cli in other orgs w/o issue. What should I do to get all 80 pages pulled?

Thanks,
Peter

page-pack command ignores (-n and -m) arguments

Command used:
skuid page-pack -o [Package name] -m [Module Name]
or
skuid page-pack -o [Package name] -n [Page name]

It seems like page-pack command ignores -m and -m arguments, it doesn't retrieve pages that are specified by -n or pages within module specified by -m. Regardless of which argument I use, it retrieves all pages that don't have a module.

Also, would it be possible for page-pack to create [Package name].resource-meta.xml file alongside the page package, where the content would be:

Private application/json

It would be easier for Version Control.

Add Login command ala Force CLI

The force CLI allows you to log into multiple orgs in multiple ways. The skuid CLI should do so as well.

With force you can log into orgs in the following ways:

1. force login -u $username -p $password - According to their codebase, this uses the SOAP Api to log in
2. force login - This method opens a Salesforce login page and authenticates via OAuth.

In both cases, access tokens and other relevant user information are are persisted at ~/.force/accounts/{username} with a reference to the currently active org persisted at ~/.force/accounts/current.

This would allow users of skuid to manage multiple logins without having to manage bash scripts that can reset environment variables per org. This should be relatively simple to implement following the force example.

Error: Post /services/oauth2/token: unsupported protocol scheme ""

Unable to execute skuid command without the "--host" flag.

Commands:
skuid pull -m Dashboard
skuid pull -m Dashboard --host my-domain.my.salesforce.com

Error:
Post /services/oauth2/token: unsupported protocol scheme ""

Works with "https://" + "my-domain.my.salesforce.com"

Command: skuid pull -m Dashboard --host https://my-domain.my.salesforce.com

New to this, so may be missing configuration somewhere.

skuid pull in 0.3.0

skuid is alias for skuid_windows_amd64.exe on Windows and for skuid_darwin_amd64 on Mac

I tried this command on both Windows and Mac and it fails:
skuid pull --host https://.my.salesforce.com -n PageName -v

Error:
"{"error":"You must provide a \"module\" URL Parameter containing the nam
e, or comma-separated names, of the Modules of pages you would like to retrieve
"}"
json: cannot unmarshal string into Go value of type types.PullResponse

This command works:
skuid pull --host https://.my.salesforce.com -m ModuleName

System.LimitException: Apex heap size too large

Testing with a Salesforce org with a huge number of pages. Thought I would report, especially if one wants to pull all pages in an org.

Command: skuid pull --host https://.my.salesforce.com

Full message: {"errorCode":"APEX_ERROR","message":"System.LimitException: Apex heap size too large: 49153240\n\nExternal entry point\n(skuid)\n"}]
unexpected end of JSON input

Release 0.3.10 doe not return any metadata with "skuid retrieve"

Upgraded skuid CLI to 0.3.10 and the "skuid retrieve" does not return any metadata. Release 0.3.9 is working.

Environment is Windows using PowerShell.

Support pre-authenticated Access Token in addition to username/password.

skuid push command: In verbose mode, show names of pages to be pushed

As a user of the skuid push command, it would be helpful if, with the --verbose flag enabled, the command displayed the names of all pages that were going to be pushed, so that I could know exactly which pages Skuid CLI is going to attempt to push.

Ability to deploy to Skuid Site

skuid push command: XML limit lower than Salesforce XML limit

As a user, when I use skuid:page:push to push a single page with 6992 lines of xml, the result in the salesforce org is only 6755 lines of xml are pushed to the org.

Pages without a module cannot be pushed with the Directory or Module flags

Pages outside of a module should have been written to disk with an _ before the name (ex. _NonModularizedPage instead of NonModularizedPage. Since the original implementation does not do this, we should fix the push command to take this into account.