cad-siteProps(1)

Michael Slinn (mslinn@micronauticsresearch.com)

10 May 2019

NAME

cad siteProps - a Cadenza Client™ command that reports property values for a given site.

SYNOPSIS

cad [OPTION]… siteProps propertyName id cad [OPTION]… siteProps -s id cad [OPTION]… siteProps -h

DESCRIPTION

cad-siteProps returns the properties object for the given site. The properties object for a site is stored in a file called site.json within the site’s directory within $cadenzaCurriculum. References properties object for all properties, and enhances with environment variables to fill out complete paths for:

absoluteCreativeProjectPath
Computed from creativeProjectPath in site.json, relative to $cadenzaCreative.
absoluteCurriculumProject
Computed from curriculumProjectPath in site.json, relative to $cadenzaCurriculum.
absoluteDWPath
Computed from dwPath in site.json, relative to $cadenzaCurriculum.
absolutePromoDWSte
Computed from promoDWPath in site.json, relative to $cadenzaCurriculum.
absolutePropertyObjectPath
Computed from propertyObjectPath in site.json, relative to $cadenzaCurriculum.

ACTION_OPTIONS

-h
Shows this man page.
-s
(Re)compute and save the property object in the appropriate directory within $cadenzaCurriculum. Increments the version property value. Returns the empty string.

EXAMPLES

cad siteProps -h
Shows this man page.
cad siteProps -s 1
Persists the properties object for site #1.
cad siteProps .creativeProjectPath 1
This jq query returns something like: ScalaCourses.com
cad siteProps absoluteCreativeProjectPath 1
This computed property returns something like: /mnt/c/work/cadenzaHome/cadenzaCreative/ScalaCourses.com
cad siteProps .cadenzaCurriculum 1
This jq query returns something like: ScalaCourses.com
cad siteProps absoluteCurriculumProject 1
This computed property returns something like: /mnt/c/work/cadenzaHome/cadenzaCurriculum/ScalaCourses.com
cad siteProps absolutePromoPath 40
This computed property returns something like: /mnt/c/work/cadenzaHome/cadenzaCurriculum/ScalaCourses.com/promo
cad siteProps .promoDWSte 40
This jq query returns something like: ScalaCourses.com/promo/ScalaCourses.com.ste
cad siteProps absolutePromoDWSte 40
This computed property returns something like: /mnt/c/work/cadenzaHome/cadenzaCurriculum/ScalaCourses.com/promo/ScalaCourses.com.ste
cad siteProps .propertyObjectPath 1
This jq query returns something like: ScalaCourses.com/site.json
cad siteProps absolutePropertyObjectPath 103
This computed property returns something like: /mnt/c/work/cadenzaHome/cadenzaCurriculum/ScalaCourses.com/site.json
cad siteProps '.lecture|.name' 103
This jq query returns something like: ScalaCourses.com
cad siteProps ‘.video|.renderedPath’ 13
This jq query returns something like: 1/html/ScalaCore/assets/videos/pubConf_ScalaCourses.com.mp4

SAMPLE site.json

{
  "creative": {
    "downloadedFrom": "production",
    "lastDownloaded": "12345"
    "lastUploaded": [
      {
        "to": "production",
        "on": "12345"
      },
      {
        "to": "localhost",
        "on": "1234"
      }
    ]
  },
  "version": 4,
  "gitCreated": "12345",
  "indexLastModified": "12345",
  "jsonCreated": "12345",
  "jsonVersion": "3",
  "creativeProjectPath": "ScalaCourses.com/ScalaCourses.com",
  "curriculumProjectPath": "ScalaCourses.com/ScalaCourses.com",
  "dwPath": "ScalaCourses.com/promo",
  "dwSte": "ScalaCourses.com/promo/ScalaCourses.ste",
  "propertyObjectPath": "ScalaCourses.com/site.json",
  "site": {
    "id": 1,
    "name": "ScalaCourses.com"
  },
  "video": {
    "renderedUrl": "https://courseassets.scalacourses.com/1/html/ScalaCore/assets/videos/pubConf_ScalaCourses.com.mp4",
    "transcodedUrl": "https://courseassets.scalacourses.com/1/html/ScalaCore/assets/videos/tx/pubConf_ScalaCourses.com_Web.mp4",
    "stageDomain": "courseassets.scalacourses.com",
    "renderedPath": "1/html/ScalaCore/assets/videos/pubConf_ScalaCourses.com.mp4",
    "transcodedPath": "1/html/ScalaCore/assets/videos/tx/pubConf_ScalaCourses.com_Web.mp4"
  }
}

SEE ALSO

cad site(1), cad(1)