@shuffl/cli 0.2.0 → 0.2.1

package/dist/commands.generated.js

@@ -62,7 +62,7 @@ export const commands = [
         path: ['access', 'get'],
         permission: 'access.get',
         scope: 'access:read',
-        summary: 'access.get',
+        summary: "Read one person's workspace role and app access",
     },
     {
         access: 'write',
@@ -214,7 +214,7 @@ export const commands = [
         path: ['access', 'slackWaiting'],
         permission: 'access.slackWaiting',
         scope: 'access:read',
-        summary: 'access.slackWaiting',
+        summary: 'List Slack members waiting for access to Shuffl',
     },
     {
         access: 'read',
@@ -228,7 +228,7 @@ export const commands = [
         path: ['assistant', 'conversations'],
         permission: 'assistant.conversations',
         scope: 'assistant:read',
-        summary: 'assistant.conversations',
+        summary: 'List your conversations with Mello',
     },
     {
         access: 'write',
@@ -252,7 +252,7 @@ export const commands = [
         path: ['assistant', 'delete'],
         permission: 'assistant.delete',
         scope: 'assistant:write',
-        summary: 'assistant.delete',
+        summary: 'Delete one of your conversations with Mello',
     },
     {
         access: 'read',
@@ -271,7 +271,7 @@ export const commands = [
         path: ['assistant', 'history'],
         permission: 'assistant.history',
         scope: 'assistant:read',
-        summary: 'assistant.history',
+        summary: 'Read the messages in one of your conversations with Mello',
     },
     {
         access: 'write',
@@ -301,7 +301,7 @@ export const commands = [
         path: ['assistant', 'send'],
         permission: 'assistant.send',
         scope: 'assistant:write',
-        summary: 'assistant.send',
+        summary: 'Ask Mello a question in a conversation',
     },
     {
         access: 'write',
@@ -325,7 +325,7 @@ export const commands = [
         path: ['assistant', 'stop'],
         permission: 'assistant.stop',
         scope: 'assistant:write',
-        summary: 'assistant.stop',
+        summary: 'Stop an answer Mello is still writing',
     },
     {
         access: 'write',
@@ -414,7 +414,7 @@ export const commands = [
         path: ['badges', 'decideRequest'],
         permission: 'badges.decideRequest',
         scope: 'profile:write',
-        summary: 'badges.decideRequest',
+        summary: 'Approve or decline a request for a badge',
     },
     {
         access: 'write',
@@ -484,7 +484,7 @@ export const commands = [
         path: ['badges', 'hideOwn'],
         permission: 'badges.hideOwn',
         scope: 'profile:write',
-        summary: 'badges.hideOwn',
+        summary: 'Hide or show one of your badges on your profile',
     },
     {
         access: 'read',
@@ -536,7 +536,7 @@ export const commands = [
         path: ['badges', 'ofPerson'],
         permission: 'badges.ofPerson',
         scope: 'users:read',
-        summary: 'badges.ofPerson',
+        summary: "List a person's badges",
     },
     {
         access: 'write',
@@ -563,7 +563,7 @@ export const commands = [
         path: ['badges', 'request'],
         permission: 'badges.request',
         scope: 'profile:write',
-        summary: 'badges.request',
+        summary: 'Ask for a badge',
     },
     {
         access: 'write',
@@ -590,7 +590,7 @@ export const commands = [
         path: ['badges', 'revoke'],
         permission: 'badges.revoke',
         scope: 'profile:write',
-        summary: 'badges.revoke',
+        summary: 'Take a badge back from a person',
     },
     {
         access: 'write',
@@ -767,7 +767,7 @@ export const commands = [
         path: ['badges', 'setHidden'],
         permission: 'badges.setHidden',
         scope: 'users:write',
-        summary: 'badges.setHidden',
+        summary: 'Hide or show a badge for the whole workspace',
     },
     {
         access: 'read',
@@ -863,7 +863,7 @@ export const commands = [
         path: ['celebrations', 'deliveries'],
         permission: 'celebrations.deliveries',
         scope: 'celebrations:read',
-        summary: 'celebrations.deliveries',
+        summary: 'List the celebration messages Shuffl sent',
     },
     {
         access: 'read',
@@ -877,7 +877,7 @@ export const commands = [
         path: ['celebrations', 'mine'],
         permission: 'celebrations.mine',
         scope: 'self:read',
-        summary: 'celebrations.mine',
+        summary: 'List the celebrations you received',
     },
     {
         access: 'read',
@@ -891,7 +891,7 @@ export const commands = [
         path: ['celebrations', 'preferences'],
         permission: 'celebrations.preferences',
         scope: 'self:read',
-        summary: 'celebrations.preferences',
+        summary: 'Read your birthday and work anniversary sharing preferences',
     },
     {
         access: 'read',
@@ -958,7 +958,7 @@ export const commands = [
         path: ['celebrations', 'preview'],
         permission: 'celebrations.preview',
         scope: 'celebrations:read',
-        summary: 'celebrations.preview',
+        summary: 'Preview a celebration message',
     },
     {
         access: 'read',
@@ -972,7 +972,7 @@ export const commands = [
         path: ['celebrations', 'program'],
         permission: 'celebrations.program',
         scope: 'celebrations:read',
-        summary: 'celebrations.program',
+        summary: 'Read the Celebrations settings',
     },
     {
         access: 'write',
@@ -993,7 +993,7 @@ export const commands = [
         path: ['celebrations', 'refresh'],
         permission: 'celebrations.refresh',
         scope: 'celebrations:write',
-        summary: 'celebrations.refresh',
+        summary: 'Look for new birthdays and work anniversaries to celebrate now',
     },
     {
         access: 'write',
@@ -1039,7 +1039,7 @@ export const commands = [
         path: ['celebrations', 'review'],
         permission: 'celebrations.review',
         scope: 'celebrations:read',
-        summary: 'celebrations.review',
+        summary: 'Review upcoming birthdays and work anniversaries',
     },
     {
         access: 'write',
@@ -1208,7 +1208,7 @@ export const commands = [
         path: ['celebrations', 'savePreferences'],
         permission: 'celebrations.savePreferences',
         scope: 'self:write',
-        summary: 'celebrations.savePreferences',
+        summary: 'Save your birthday and work anniversary sharing preferences',
     },
     {
         access: 'write',
@@ -1263,7 +1263,7 @@ export const commands = [
         path: ['communities', 'archive'],
         permission: 'communities.archive',
         scope: 'profile:write',
-        summary: 'communities.archive',
+        summary: 'Archive a community',
     },
     {
         access: 'read',
@@ -1540,7 +1540,7 @@ export const commands = [
         path: ['communities', 'join'],
         permission: 'communities.join',
         scope: 'profile:write',
-        summary: 'communities.join',
+        summary: 'Join a community',
     },
     {
         access: 'write',
@@ -1564,7 +1564,7 @@ export const commands = [
         path: ['communities', 'leave'],
         permission: 'communities.leave',
         scope: 'profile:write',
-        summary: 'communities.leave',
+        summary: 'Leave a community',
     },
     {
         access: 'read',
@@ -1597,7 +1597,7 @@ export const commands = [
         path: ['communities', 'members'],
         permission: 'communities.members',
         scope: 'users:read',
-        summary: 'communities.members',
+        summary: "List a community's members",
     },
     {
         access: 'read',
@@ -1616,7 +1616,7 @@ export const commands = [
         path: ['communities', 'ofPerson'],
         permission: 'communities.ofPerson',
         scope: 'users:read',
-        summary: 'communities.ofPerson',
+        summary: 'List the communities a person belongs to',
     },
     {
         access: 'write',
@@ -1841,7 +1841,7 @@ export const commands = [
         path: ['communities', 'setVisibility'],
         permission: 'communities.setVisibility',
         scope: 'profile:write',
-        summary: 'communities.setVisibility',
+        summary: 'Show or hide a community on your profile',
     },
     {
         access: 'write',
@@ -1865,7 +1865,7 @@ export const commands = [
         path: ['communities', 'sync'],
         permission: 'communities.sync',
         scope: 'profile:write',
-        summary: 'communities.sync',
+        summary: "Sync a community's members with its Slack channel now",
     },
     {
         access: 'write',
@@ -3171,7 +3171,7 @@ export const commands = [
         path: ['credentials', 'api', 'list'],
         permission: 'credentials.api.list',
         scope: 'credentials:read',
-        summary: 'credentials.api.list',
+        summary: "List the workspace's API keys and what each can do",
     },
     {
         access: 'write',
@@ -3195,7 +3195,7 @@ export const commands = [
         path: ['credentials', 'api', 'revoke'],
         permission: 'credentials.api.revoke',
         scope: 'credentials:write',
-        summary: 'credentials.api.revoke',
+        summary: 'Revoke an API key',
     },
     {
         access: 'write',
@@ -3456,7 +3456,7 @@ export const commands = [
         path: ['exports', 'team'],
         permission: 'exports.team',
         scope: 'exports:read',
-        summary: 'exports.team',
+        summary: "Export the workspace's programs, people and introduction history",
     },
     {
         access: 'write',
@@ -3977,7 +3977,7 @@ export const commands = [
         path: ['hr', 'command'],
         permission: 'hr.command',
         scope: 'hr:write',
-        summary: 'hr.command',
+        summary: 'Claim, release, reply to, note, categorize, resolve or reopen an HR request',
     },
     {
         access: 'write',
@@ -4070,7 +4070,7 @@ export const commands = [
         path: ['hr', 'get'],
         permission: 'hr.get',
         scope: 'hr:read',
-        summary: 'hr.get',
+        summary: 'Read one HR request and its messages',
     },
     {
         access: 'read',
@@ -4084,7 +4084,7 @@ export const commands = [
         path: ['hr', 'list'],
         permission: 'hr.list',
         scope: 'hr:read',
-        summary: 'hr.list',
+        summary: 'List the HR requests you asked or can answer',
     },
     {
         access: 'read',
@@ -4098,7 +4098,7 @@ export const commands = [
         path: ['hr', 'readiness'],
         permission: 'hr.readiness',
         scope: 'hr:read',
-        summary: 'hr.readiness',
+        summary: 'Check whether HR requests have a destination and someone to answer them',
     },
     {
         access: 'write',
@@ -4147,7 +4147,7 @@ export const commands = [
         path: ['hr', 'renameTeam'],
         permission: 'hr.renameTeam',
         scope: 'hr:write',
-        summary: 'hr.renameTeam',
+        summary: 'Rename the HR team employees send requests to',
     },
     {
         access: 'write',
@@ -4254,7 +4254,7 @@ export const commands = [
         path: ['hr', 'settings'],
         permission: 'hr.settings',
         scope: 'hr:read',
-        summary: 'hr.settings',
+        summary: 'Read the HR team name and who answers HR requests',
     },
     {
         access: 'write',
@@ -4321,7 +4321,7 @@ export const commands = [
         path: ['hr', 'shareSources'],
         permission: 'hr.shareSources',
         scope: 'hr:read',
-        summary: 'hr.shareSources',
+        summary: 'List your recent Mello conversations that an HR request can include',
     },
     {
         access: 'write',
@@ -4415,7 +4415,7 @@ export const commands = [
         path: ['identities', 'list'],
         permission: 'identities.list',
         scope: 'identities:read',
-        summary: 'identities.list',
+        summary: 'List the Slack and web accounts linked to a person',
     },
     {
         access: 'read',
@@ -4433,7 +4433,7 @@ export const commands = [
         path: ['identities', 'slackAccounts'],
         permission: 'identities.slackAccounts',
         scope: 'identities:read',
-        summary: 'identities.slackAccounts',
+        summary: 'List Slack accounts that can be linked to people',
     },
     {
         access: 'write',
@@ -4494,7 +4494,7 @@ export const commands = [
         path: ['identities', 'webAccounts'],
         permission: 'identities.webAccounts',
         scope: 'identities:read',
-        summary: 'identities.webAccounts',
+        summary: 'List web accounts that can be linked to people',
     },
     {
         access: 'read',
@@ -4526,7 +4526,7 @@ export const commands = [
         path: ['integrations', 'authorize'],
         permission: 'integrations.authorize',
         scope: 'integrations:write',
-        summary: 'integrations.authorize',
+        summary: 'Get the link that connects Slack, Google Drive or Notion to the workspace',
     },
     {
         access: 'write',
@@ -4550,7 +4550,7 @@ export const commands = [
         path: ['invitations', 'cancel'],
         permission: 'invitations.cancel',
         scope: 'access:write',
-        summary: 'invitations.cancel',
+        summary: 'Cancel a pending workspace invitation',
     },
     {
         access: 'read',
@@ -4568,7 +4568,7 @@ export const commands = [
         path: ['invitations', 'candidates'],
         permission: 'invitations.candidates',
         scope: 'access:read',
-        summary: 'invitations.candidates',
+        summary: 'List people in the directory who can be invited to the workspace',
     },
     {
         access: 'write',
@@ -4690,7 +4690,7 @@ export const commands = [
         path: ['invitations', 'list'],
         permission: 'invitations.list',
         scope: 'access:read',
-        summary: 'invitations.list',
+        summary: 'List pending workspace invitations',
     },
     {
         access: 'read',
@@ -4837,7 +4837,7 @@ export const commands = [
         path: ['knowledge', 'connections', 'list'],
         permission: 'knowledge.connections.list',
         scope: 'integrations:read',
-        summary: 'knowledge.connections.list',
+        summary: 'List connected Knowledge providers',
     },
     {
         access: 'write',
@@ -4861,7 +4861,7 @@ export const commands = [
         path: ['knowledge', 'connections', 'request'],
         permission: 'knowledge.connections.request',
         scope: 'integrations:write',
-        summary: 'knowledge.connections.request',
+        summary: 'Ask an administrator to connect a Knowledge source',
     },
     {
         access: 'read',
@@ -4875,7 +4875,7 @@ export const commands = [
         path: ['knowledge', 'connections', 'requests'],
         permission: 'knowledge.connections.requests',
         scope: 'integrations:read',
-        summary: 'knowledge.connections.requests',
+        summary: 'List requests to connect a Knowledge source',
     },
     {
         access: 'read',
@@ -4889,7 +4889,7 @@ export const commands = [
         path: ['knowledge', 'policies', 'coverage'],
         permission: 'knowledge.policies.coverage',
         scope: 'knowledge:manage',
-        summary: 'knowledge.policies.coverage',
+        summary: 'Check which common HR policies Knowledge covers',
     },
     {
         access: 'write',
@@ -5022,7 +5022,7 @@ export const commands = [
         path: ['knowledge', 'sources', 'get'],
         permission: 'knowledge.sources.get',
         scope: 'knowledge:manage',
-        summary: 'knowledge.sources.get',
+        summary: 'Read a Knowledge source',
     },
     {
         access: 'read',
@@ -5041,7 +5041,7 @@ export const commands = [
         path: ['knowledge', 'sources', 'history'],
         permission: 'knowledge.sources.history',
         scope: 'knowledge:manage',
-        summary: 'knowledge.sources.history',
+        summary: "List a Knowledge source's versions",
     },
     {
         access: 'write',
@@ -5189,7 +5189,7 @@ export const commands = [
         path: ['knowledge', 'sources', 'importWebsite'],
         permission: 'knowledge.sources.importWebsite',
         scope: 'knowledge:write',
-        summary: 'knowledge.sources.importWebsite',
+        summary: 'Import a website page into Knowledge for review',
     },
     {
         access: 'read',
@@ -5309,7 +5309,7 @@ export const commands = [
         path: ['knowledge', 'sources', 'list'],
         permission: 'knowledge.sources.list',
         scope: 'knowledge:manage',
-        summary: 'knowledge.sources.list',
+        summary: 'List Knowledge sources',
     },
     {
         access: 'write',
@@ -5401,7 +5401,7 @@ export const commands = [
         path: ['knowledge', 'sources', 'refresh'],
         permission: 'knowledge.sources.refresh',
         scope: 'knowledge:write',
-        summary: 'knowledge.sources.refresh',
+        summary: 'Refresh a Knowledge source from its connected provider',
     },
     {
         access: 'write',
@@ -5527,7 +5527,7 @@ export const commands = [
         path: ['knowledge', 'sources', 'save'],
         permission: 'knowledge.sources.save',
         scope: 'knowledge:write',
-        summary: 'knowledge.sources.save',
+        summary: 'Save a Knowledge source draft',
     },
     {
         access: 'read',
@@ -5546,7 +5546,7 @@ export const commands = [
         path: ['knowledge', 'sources', 'search'],
         permission: 'knowledge.sources.search',
         scope: 'knowledge:read',
-        summary: 'knowledge.sources.search',
+        summary: 'Search Knowledge sources by title',
     },
     {
         access: 'write',
@@ -5573,7 +5573,7 @@ export const commands = [
         path: ['knowledge', 'sources', 'withdraw'],
         permission: 'knowledge.sources.withdraw',
         scope: 'knowledge:write',
-        summary: 'knowledge.sources.withdraw',
+        summary: 'Withdraw a published Knowledge source',
     },
     {
         access: 'write',
@@ -5652,7 +5652,7 @@ export const commands = [
         path: ['knowledge', 'uploads', 'appendPart'],
         permission: 'knowledge.uploads.appendPart',
         scope: 'knowledge:write',
-        summary: 'knowledge.uploads.appendPart',
+        summary: 'Upload the next part of a Knowledge file',
     },
     {
         access: 'write',
@@ -5676,7 +5676,7 @@ export const commands = [
         path: ['knowledge', 'uploads', 'complete'],
         permission: 'knowledge.uploads.complete',
         scope: 'knowledge:write',
-        summary: 'knowledge.uploads.complete',
+        summary: 'Finish a Knowledge file upload and start reading it',
     },
     {
         access: 'write',
@@ -5709,7 +5709,7 @@ export const commands = [
         path: ['knowledge', 'uploads', 'create'],
         permission: 'knowledge.uploads.create',
         scope: 'knowledge:write',
-        summary: 'knowledge.uploads.create',
+        summary: 'Start uploading a file to Knowledge',
     },
     {
         access: 'read',
@@ -5728,7 +5728,7 @@ export const commands = [
         path: ['knowledge', 'uploads', 'get'],
         permission: 'knowledge.uploads.get',
         scope: 'knowledge:write',
-        summary: 'knowledge.uploads.get',
+        summary: 'Read the progress of a Knowledge file upload',
     },
     {
         access: 'write',
@@ -5752,7 +5752,7 @@ export const commands = [
         path: ['knowledge', 'uploads', 'retry'],
         permission: 'knowledge.uploads.retry',
         scope: 'knowledge:write',
-        summary: 'knowledge.uploads.retry',
+        summary: 'Retry reading a Knowledge file that failed',
     },
     {
         access: 'read',
@@ -5907,7 +5907,7 @@ export const commands = [
         path: ['notifications', 'preferences'],
         permission: 'notifications.preferences',
         scope: 'self:read',
-        summary: 'notifications.preferences',
+        summary: 'Read your notification preferences',
     },
     {
         access: 'write',
@@ -6003,7 +6003,7 @@ export const commands = [
         path: ['notifications', 'save'],
         permission: 'notifications.save',
         scope: 'self:write',
-        summary: 'notifications.save',
+        summary: 'Save a notification preference',
     },
     {
         access: 'write',
@@ -6112,7 +6112,7 @@ export const commands = [
         path: ['onboarding', 'answerCheckIn'],
         permission: 'onboarding.answerCheckIn',
         scope: 'self:write',
-        summary: 'onboarding.answerCheckIn',
+        summary: 'Answer your onboarding program’s help check-in: all good, or ask HR for help',
     },
     {
         access: 'write',
@@ -6282,7 +6282,7 @@ export const commands = [
         path: ['onboarding', 'assignBuddy'],
         permission: 'onboarding.assignBuddy',
         scope: 'onboarding:write',
-        summary: 'onboarding.assignBuddy',
+        summary: 'Assign an onboarding buddy to a new hire',
     },
     {
         access: 'read',
@@ -6314,7 +6314,7 @@ export const commands = [
         path: ['onboarding', 'candidates'],
         permission: 'onboarding.candidates',
         scope: 'onboarding:read',
-        summary: 'onboarding.candidates',
+        summary: 'List people who could be enrolled in onboarding',
     },
     {
         access: 'write',
@@ -6391,7 +6391,7 @@ export const commands = [
         path: ['onboarding', 'enrollmentPreview'],
         permission: 'onboarding.enrollmentPreview',
         scope: 'onboarding:read',
-        summary: 'onboarding.enrollmentPreview',
+        summary: 'Preview enrolling a new hire in onboarding',
     },
     {
         access: 'read',
@@ -6433,7 +6433,7 @@ export const commands = [
         path: ['onboarding', 'mine'],
         permission: 'onboarding.mine',
         scope: 'self:read',
-        summary: 'onboarding.mine',
+        summary: 'Read your own onboarding plan and buddy asks',
     },
     {
         access: 'read',
@@ -6452,7 +6452,7 @@ export const commands = [
         path: ['onboarding', 'person'],
         permission: 'onboarding.person',
         scope: 'onboarding:read',
-        summary: 'onboarding.person',
+        summary: "Read a new hire's onboarding plan",
     },
     {
         access: 'write',
@@ -6503,7 +6503,7 @@ export const commands = [
         path: ['onboarding', 'previewEnrollment'],
         permission: 'onboarding.previewEnrollment',
         scope: 'onboarding:write',
-        summary: 'onboarding.previewEnrollment',
+        summary: 'Preview the onboarding steps for a new hire',
     },
     {
         access: 'read',
@@ -6522,7 +6522,7 @@ export const commands = [
         path: ['onboarding', 'program'],
         permission: 'onboarding.program',
         scope: 'onboarding:read',
-        summary: 'onboarding.program',
+        summary: 'Read the Onboarding program settings',
     },
     {
         access: 'write',
@@ -6549,7 +6549,7 @@ export const commands = [
         path: ['onboarding', 'remove'],
         permission: 'onboarding.remove',
         scope: 'onboarding:write',
-        summary: 'onboarding.remove',
+        summary: 'Remove a new hire from onboarding',
     },
     {
         access: 'write',
@@ -6585,7 +6585,7 @@ export const commands = [
         path: ['onboarding', 'respondBuddy'],
         permission: 'onboarding.respondBuddy',
         scope: 'self:write',
-        summary: 'onboarding.respondBuddy',
+        summary: 'Accept or decline being an onboarding buddy',
     },
     {
         access: 'write',
@@ -6609,7 +6609,7 @@ export const commands = [
         path: ['onboarding', 'retry'],
         permission: 'onboarding.retry',
         scope: 'onboarding:write',
-        summary: 'onboarding.retry',
+        summary: 'Retry a failed onboarding step',
     },
     {
         access: 'write',
@@ -6744,7 +6744,7 @@ export const commands = [
         path: ['onboarding', 'update'],
         permission: 'onboarding.update',
         scope: 'onboarding:write',
-        summary: 'onboarding.update',
+        summary: "Change a new hire's onboarding start date or time zone",
     },
     {
         access: 'read',
@@ -6758,7 +6758,7 @@ export const commands = [
         path: ['operations', 'activity'],
         permission: 'operations.activity',
         scope: 'operations:read',
-        summary: 'operations.activity',
+        summary: "Read the workspace's recent audit activity",
     },
     {
         access: 'write',
@@ -6843,7 +6843,7 @@ export const commands = [
         path: ['operations', 'status'],
         permission: 'operations.status',
         scope: 'operations:read',
-        summary: 'operations.status',
+        summary: 'Read the workspace delivery and provider health summary',
     },
     {
         access: 'write',
@@ -7278,7 +7278,7 @@ export const commands = [
         path: ['profiles', 'cover', 'delete'],
         permission: 'profiles.cover.delete',
         scope: 'profile:write',
-        summary: 'profiles.cover.delete',
+        summary: 'Remove your profile cover picture',
     },
     {
         access: 'write',
@@ -7392,7 +7392,7 @@ export const commands = [
         path: ['profiles', 'photo', 'delete'],
         permission: 'profiles.photo.delete',
         scope: 'profile:write',
-        summary: 'profiles.photo.delete',
+        summary: 'Remove your profile photo',
     },
     {
         access: 'write',
@@ -7419,7 +7419,7 @@ export const commands = [
         path: ['profiles', 'positions', 'delete'],
         permission: 'profiles.positions.delete',
         scope: 'profile:write',
-        summary: 'profiles.positions.delete',
+        summary: 'Remove a past position from your profile',
     },
     {
         access: 'write',
@@ -7469,7 +7469,7 @@ export const commands = [
         path: ['profiles', 'positions', 'save'],
         permission: 'profiles.positions.save',
         scope: 'profile:write',
-        summary: 'profiles.positions.save',
+        summary: 'Add or change a past position on your profile',
     },
     {
         access: 'write',
@@ -7539,7 +7539,7 @@ export const commands = [
         path: ['profiles', 'save'],
         permission: 'profiles.save',
         scope: 'profile:write',
-        summary: 'profiles.save',
+        summary: 'Save your own profile: pronouns, location, phone, bio, interests, links and what you are working on',
     },
     {
         access: 'write',
@@ -7796,7 +7796,7 @@ export const commands = [
         path: ['programs', 'people'],
         permission: 'programs.people',
         scope: 'programs:read',
-        summary: 'programs.people',
+        summary: 'List the people in a program and whether they take part',
     },
     {
         access: 'read',
@@ -8302,7 +8302,7 @@ export const commands = [
         path: ['programs', 'schedulePreview'],
         permission: 'programs.schedulePreview',
         scope: 'programs:read',
-        summary: 'programs.schedulePreview',
+        summary: "Preview a program's upcoming rounds",
     },
     {
         access: 'write',
@@ -10326,7 +10326,7 @@ export const commands = [
         path: ['reports', 'answerFeedback'],
         permission: 'reports.answerFeedback',
         scope: 'reports:read',
-        summary: 'reports.answerFeedback',
+        summary: "Read feedback on Mello's answers",
     },
     {
         access: 'read',
@@ -10360,7 +10360,7 @@ export const commands = [
         path: ['reports', 'connections'],
         permission: 'reports.connections',
         scope: 'reports:read',
-        summary: 'reports.connections',
+        summary: 'Read Connections insights',
     },
     {
         access: 'read',
@@ -10391,7 +10391,7 @@ export const commands = [
         path: ['reports', 'knowledge'],
         permission: 'reports.knowledge',
         scope: 'reports:read',
-        summary: 'reports.knowledge',
+        summary: 'Read Knowledge activity',
     },
     {
         access: 'read',
@@ -10426,7 +10426,7 @@ export const commands = [
         path: ['reports', 'knowledgeSource'],
         permission: 'reports.knowledgeSource',
         scope: 'reports:read',
-        summary: 'reports.knowledgeSource',
+        summary: 'Read activity for one Knowledge source',
     },
     {
         access: 'read',
@@ -10485,7 +10485,7 @@ export const commands = [
         path: ['reports', 'needsYou'],
         permission: 'reports.needsYou',
         scope: 'reports:read',
-        summary: 'reports.needsYou',
+        summary: 'Read HR request and Knowledge draft insights',
     },
     {
         access: 'read',
@@ -10519,7 +10519,7 @@ export const commands = [
         path: ['reports', 'onboarding'],
         permission: 'reports.onboarding',
         scope: 'reports:read',
-        summary: 'reports.onboarding',
+        summary: 'Read Onboarding insights',
     },
     {
         access: 'read',
@@ -10533,7 +10533,7 @@ export const commands = [
         path: ['reports', 'overview'],
         permission: 'reports.overview',
         scope: 'reports:read',
-        summary: 'reports.overview',
+        summary: 'Read the workspace overview figures',
     },
     {
         access: 'read',
@@ -10564,7 +10564,7 @@ export const commands = [
         path: ['reports', 'people'],
         permission: 'reports.people',
         scope: 'reports:read',
-        summary: 'reports.people',
+        summary: 'Read People insights: headcount, teams and growth',
     },
     {
         access: 'read',
@@ -10583,7 +10583,7 @@ export const commands = [
         path: ['runs', 'details'],
         permission: 'runs.details',
         scope: 'runs:read',
-        summary: 'runs.details',
+        summary: 'Read one introduction round and its pairs',
     },
     {
         access: 'write',
@@ -10630,7 +10630,7 @@ export const commands = [
         path: ['runs', 'history', 'get'],
         permission: 'runs.history.get',
         scope: 'exports:read',
-        summary: 'runs.history.get',
+        summary: 'Read one introduction round imported from the previous Shuffl',
     },
     {
         access: 'read',
@@ -10648,7 +10648,7 @@ export const commands = [
         path: ['runs', 'history', 'list'],
         permission: 'runs.history.list',
         scope: 'exports:read',
-        summary: 'runs.history.list',
+        summary: 'List introduction rounds imported from the previous Shuffl',
     },
     {
         access: 'read',
@@ -10709,7 +10709,7 @@ export const commands = [
         path: ['runs', 'list'],
         permission: 'runs.list',
         scope: 'runs:read',
-        summary: 'runs.list',
+        summary: "List a program's introduction rounds",
     },
     {
         access: 'write',
@@ -10870,7 +10870,7 @@ export const commands = [
         path: ['support', 'assign'],
         permission: 'support.assign',
         scope: 'support:write',
-        summary: 'support.assign',
+        summary: 'Assign a Shuffl support conversation',
     },
     {
         access: 'write',
@@ -10897,7 +10897,7 @@ export const commands = [
         path: ['support', 'close'],
         permission: 'support.close',
         scope: 'support:write',
-        summary: 'support.close',
+        summary: 'Close a Shuffl support conversation',
     },
     {
         access: 'write',
@@ -10924,7 +10924,7 @@ export const commands = [
         path: ['support', 'create'],
         permission: 'support.create',
         scope: 'support:write',
-        summary: 'support.create',
+        summary: 'Start a support conversation with Shuffl',
     },
     {
         access: 'read',
@@ -10955,7 +10955,7 @@ export const commands = [
         path: ['support', 'get'],
         permission: 'support.get',
         scope: 'support:read',
-        summary: 'support.get',
+        summary: 'Read one Shuffl support conversation',
     },
     {
         access: 'read',
@@ -10982,7 +10982,7 @@ export const commands = [
         path: ['support', 'list'],
         permission: 'support.list',
         scope: 'support:read',
-        summary: 'support.list',
+        summary: "List the workspace's support conversations with Shuffl",
     },
     {
         access: 'write',
@@ -11024,7 +11024,7 @@ export const commands = [
         path: ['support', 'reply'],
         permission: 'support.reply',
         scope: 'support:write',
-        summary: 'support.reply',
+        summary: 'Reply in a Shuffl support conversation',
     },
     {
         access: 'write',
@@ -11064,6 +11064,10 @@ export const commands = [
                             const: 'google_team',
                             type: 'string',
                         },
+                        {
+                            const: 'google_workspace',
+                            type: 'string',
+                        },
                         {
                             const: 'gusto',
                             type: 'string',
@@ -11136,7 +11140,7 @@ export const commands = [
         path: ['sync', 'current'],
         permission: 'sync.current',
         scope: 'integrations:read',
-        summary: 'sync.current',
+        summary: 'Read the People sync provider, its last sync and what it found',
     },
     {
         access: 'write',
@@ -11188,7 +11192,7 @@ export const commands = [
         path: ['sync', 'request'],
         permission: 'sync.request',
         scope: 'integrations:write',
-        summary: 'sync.request',
+        summary: 'Ask for a People sync provider Shuffl does not support yet',
     },
     {
         access: 'write',
@@ -11212,7 +11216,7 @@ export const commands = [
         path: ['sync', 'run'],
         permission: 'sync.run',
         scope: 'integrations:write',
-        summary: 'sync.run',
+        summary: 'Sync People from the connected provider now',
     },
     {
         access: 'write',
@@ -11291,7 +11295,7 @@ export const commands = [
         path: ['team', 'launchPost'],
         permission: 'team.launchPost',
         scope: 'team:read',
-        summary: 'team.launchPost',
+        summary: 'Read the launch announcement for the workspace',
     },
     {
         access: 'read',
@@ -11305,7 +11309,7 @@ export const commands = [
         path: ['teams', 'connectionPermissions'],
         permission: 'teams.connectionPermissions',
         scope: 'team:read',
-        summary: 'teams.connectionPermissions',
+        summary: 'List connections whose permissions are behind what Shuffl asks for',
     },
     {
         access: 'write',
@@ -11354,7 +11358,7 @@ export const commands = [
         path: ['teams', 'initialize'],
         permission: 'teams.initialize',
         scope: 'team:write',
-        summary: 'teams.initialize',
+        summary: 'Finish setting up a new workspace',
     },
     {
         access: 'write',
@@ -11439,7 +11443,7 @@ export const commands = [
         path: ['teams', 'rename'],
         permission: 'teams.rename',
         scope: 'team:write',
-        summary: 'teams.rename',
+        summary: 'Rename the workspace',
     },
     {
         access: 'write',
@@ -11516,7 +11520,7 @@ export const commands = [
         path: ['teams', 'saveAgentSetup'],
         permission: 'teams.saveAgentSetup',
         scope: 'team:write',
-        summary: 'teams.saveAgentSetup',
+        summary: 'Choose the built-in assistant or an external agent for the workspace',
     },
     {
         access: 'write',
@@ -11540,7 +11544,7 @@ export const commands = [
         path: ['teams', 'saveSlackJoinAccess'],
         permission: 'teams.saveSlackJoinAccess',
         scope: 'team:write',
-        summary: 'teams.saveSlackJoinAccess',
+        summary: 'Choose whether Slack members can join Shuffl on their own',
     },
     {
         access: 'write',
@@ -11564,7 +11568,7 @@ export const commands = [
         path: ['teams', 'saveSlackProfileLink'],
         permission: 'teams.saveSlackProfileLink',
         scope: 'team:write',
-        summary: 'teams.saveSlackProfileLink',
+        summary: 'Turn the Shuffl profile link on Slack profiles on or off',
     },
     {
         access: 'read',
@@ -11578,7 +11582,7 @@ export const commands = [
         path: ['teams', 'setup'],
         permission: 'teams.setup',
         scope: 'team:read',
-        summary: 'teams.setup',
+        summary: "Read the workspace's setup checklist",
     },
     {
         access: 'read',
@@ -11592,7 +11596,7 @@ export const commands = [
         path: ['teams', 'slackChannels'],
         permission: 'teams.slackChannels',
         scope: 'integrations:read',
-        summary: 'teams.slackChannels',
+        summary: 'List community channels in the connected Slack and what each would become',
     },
     {
         access: 'read',
@@ -11606,7 +11610,7 @@ export const commands = [
         path: ['teams', 'slackJoinAccess'],
         permission: 'teams.slackJoinAccess',
         scope: 'team:read',
-        summary: 'teams.slackJoinAccess',
+        summary: 'Read whether Slack members can join Shuffl on their own',
     },
     {
         access: 'read',
@@ -11620,7 +11624,7 @@ export const commands = [
         path: ['teams', 'slackProfileLink'],
         permission: 'teams.slackProfileLink',
         scope: 'team:read',
-        summary: 'teams.slackProfileLink',
+        summary: 'Read the Shuffl profile link setting for Slack profiles',
     },
     {
         access: 'write',
@@ -11653,7 +11657,7 @@ export const commands = [
         path: ['teams', 'status'],
         permission: 'teams.status',
         scope: 'team:write',
-        summary: 'teams.status',
+        summary: 'Pause or resume the whole workspace',
     },
     {
         access: 'write',
@@ -11759,7 +11763,7 @@ export const commands = [
         path: ['units', 'archive'],
         permission: 'units.archive',
         scope: 'users:write',
-        summary: 'units.archive',
+        summary: 'Archive a team or department in the People directory',
     },
     {
         access: 'read',
@@ -11786,7 +11790,7 @@ export const commands = [
         path: ['units', 'list'],
         permission: 'units.list',
         scope: 'users:read',
-        summary: 'units.list',
+        summary: 'List the teams and departments in the People directory',
     },
     {
         access: 'write',
@@ -11828,7 +11832,7 @@ export const commands = [
         path: ['units', 'save'],
         permission: 'units.save',
         scope: 'users:write',
-        summary: 'units.save',
+        summary: 'Create or rename a team or department in the People directory',
     },
     {
         access: 'read',
@@ -11847,7 +11851,7 @@ export const commands = [
         path: ['users', 'activity'],
         permission: 'users.activity',
         scope: 'users:read',
-        summary: 'users.activity',
+        summary: "Read a person's recent activity in Shuffl",
     },
     {
         access: 'write',
@@ -11902,7 +11906,7 @@ export const commands = [
         path: ['users', 'blockedPairs'],
         permission: 'users.blockedPairs',
         scope: 'users:read',
-        summary: 'users.blockedPairs',
+        summary: 'List pairs of people who are never introduced',
     },
     {
         access: 'write',
@@ -11932,7 +11936,7 @@ export const commands = [
         path: ['users', 'blockPair'],
         permission: 'users.blockPair',
         scope: 'users:write',
-        summary: 'users.blockPair',
+        summary: 'Stop two people from being introduced to each other',
     },
     {
         access: 'read',
@@ -11951,7 +11955,7 @@ export const commands = [
         path: ['users', 'details'],
         permission: 'users.details',
         scope: 'users:read',
-        summary: 'users.details',
+        summary: "Read one person's People directory record",
     },
     {
         access: 'read',
@@ -11965,7 +11969,7 @@ export const commands = [
         path: ['users', 'filterOptions'],
         permission: 'users.filterOptions',
         scope: 'users:read',
-        summary: 'users.filterOptions',
+        summary: 'List the teams, departments, managers and locations People can filter by',
     },
     {
         access: 'read',
@@ -11987,7 +11991,7 @@ export const commands = [
         path: ['users', 'managerHistory'],
         permission: 'users.managerHistory',
         scope: 'users:read',
-        summary: 'users.managerHistory',
+        summary: "Read a person's recorded manager history",
     },
     {
         access: 'read',
@@ -12008,7 +12012,7 @@ export const commands = [
         path: ['users', 'managers'],
         permission: 'users.managers',
         scope: 'users:read',
-        summary: 'users.managers',
+        summary: 'List the managers in the People directory',
     },
     {
         access: 'read',
@@ -12166,7 +12170,7 @@ export const commands = [
         path: ['users', 'page'],
         permission: 'users.page',
         scope: 'users:read',
-        summary: 'users.page',
+        summary: 'List people in the People directory: search, or filter by team, department, manager, location, access or workspace role such as owner, admin or HR responder',
     },
     {
         access: 'read',
@@ -12184,7 +12188,7 @@ export const commands = [
         path: ['users', 'participants'],
         permission: 'users.participants',
         scope: 'users:read',
-        summary: 'users.participants',
+        summary: 'List the people who take part in programs',
     },
     {
         access: 'write',
@@ -12217,7 +12221,7 @@ export const commands = [
         path: ['users', 'participation'],
         permission: 'users.participation',
         scope: 'participation:write',
-        summary: 'users.participation',
+        summary: 'Opt a person in to or out of a program',
     },
     {
         access: 'write',
@@ -12271,7 +12275,7 @@ export const commands = [
         path: ['users', 'profile'],
         permission: 'users.profile',
         scope: 'profile:write',
-        summary: 'users.profile',
+        summary: "Edit a person's profile as an administrator",
     },
     {
         access: 'write',
@@ -12449,7 +12453,7 @@ export const commands = [
         path: ['users', 'save'],
         permission: 'users.save',
         scope: 'users:write',
-        summary: 'users.save',
+        summary: "Change someone's People directory record as an administrator: name, job title, manager, team, department or start date",
     },
     {
         access: 'read',

package/package.json

@@ -1,8 +1,8 @@
 {
   "dependencies": {
     "@orpc/client": "1.15.3",
-    "@shuffl/api-contracts": "0.2.0",
-    "@shuffl/sdk": "0.2.0"
+    "@shuffl/api-contracts": "0.2.1",
+    "@shuffl/sdk": "0.2.1"
   },
   "description": "Shuffl command line: every public API operation as a scriptable command with JSON output.",
   "engines": {
@@ -33,7 +33,7 @@
   "sideEffects": false,
   "type": "module",
   "types": "./dist/index.d.ts",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "bin": {
     "shuffl": "./dist/bin.js"
   }