Official CLI for itopia Spaces

An oclif-based CLI wrapper for the itopia Spaces API

For more information about itopia Spaces, see https://spaces.itopia.com

For more information about the itopia Spaces API, see https://api.spaces.itopia.com

Usage

Download a pre-built executable for your OS, attached to the latest release.
Save it with the name spaces in a convenient directory.
Run spaces help and much more!

Feedback

Questions? Requests? Please let us know on GitHub!

Build from source

If you'd prefer to build your executable from source, first ensure that you have Node.js v14 and npm v7+ installed. Then, clone this repo and run the following commands inside it:

$ npm install
$ npm run build

You should find freshly-built executables for Linux/MacOS/Windows in the repo's /dist/ directory.

Commands

The following documentation is automatically generated. While the examples should be accurate, the "See code" hyperlinks do not work.

`spaces collection:add-end-user`

Add an end user to a collection (this grants permission to use the collection's spaces)

USAGE
  $ spaces collection:add-end-user

OPTIONS
  -h, --help                   show CLI help
  --collectionId=collectionId  (required)
  --deploymentId=deploymentId  (required)
  --email=email                (required)
  --notify                     (required)

EXAMPLE
  spaces collection:end-user-add --id='abc123CollectionID' --deploymentId='abc123DeploymentID'
  --emailAddress='developer@example.com' --notify

See code: src/commands/collection/add-end-user.ts

`spaces collection:delete`

Delete a collection

USAGE
  $ spaces collection:delete

OPTIONS
  -h, --help                   show CLI help
  --collectionId=collectionId  (required)
  --deploymentId=deploymentId  (required)

EXAMPLE
  spaces collection:delete --collectionId='abc123CollectionID' --deploymentId='abc123DeploymentID'

See code: src/commands/collection/delete.ts

`spaces collection:list`

List all of your collections

USAGE
  $ spaces collection:list

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  spaces collection:list

See code: src/commands/collection/list.ts

`spaces collection:list-spaces`

List all spaces in a collection

USAGE
  $ spaces collection:list-spaces

OPTIONS
  -h, --help                   show CLI help
  --deploymentId=deploymentId  (required)
  --id=id                      (required)

EXAMPLE
  spaces collection:list-spaces --id='abc123CollectionID' --deploymentId='abc123DeploymentID'

See code: src/commands/collection/list-spaces.ts

`spaces collection:read`

Read all properties of a collection

USAGE
  $ spaces collection:read

OPTIONS
  -h, --help                   show CLI help
  --deploymentId=deploymentId  (required)
  --id=id                      (required)

EXAMPLE
  spaces collection:read --id='abc123CollectionID' --deploymentId='abc123DeploymentID'

See code: src/commands/collection/read.ts

`spaces collection:remove-end-user`

Remove an end user from a collection (this revokes permission to use the collection's spaces)

USAGE
  $ spaces collection:remove-end-user

OPTIONS
  -h, --help                   show CLI help
  --deploymentId=deploymentId  (required)
  --email=email                (required)
  --id=id                      (required)

EXAMPLE
  spaces collection:remove-end-user --id='abc123CollectionID' --deploymentId='abc123DeploymentID'
  --emailAddress='developer@example.com'

See code: src/commands/collection/remove-end-user.ts

`spaces deployment:create`

Create a new deployment

USAGE
  $ spaces deployment:create

OPTIONS
  -h, --help                         show CLI help
  --isGoogleIdentityProviderEnabled  (required)
  --name=name                        (required)
  --organizationId=organizationId    (required)
  --region=region                    (required)

EXAMPLE
  spaces deployment:create --name='My Deployment' --organizationId='abc123OrganizationID'

See code: src/commands/deployment/create.ts

`spaces deployment:delete`

Delete a deployment

USAGE
  $ spaces deployment:delete

OPTIONS
  -h, --help                       show CLI help
  --id=id                          (required)
  --organizationId=organizationId  (required)

EXAMPLE
  spaces deployment:delete --id='abc123DeploymentID' --organizationId='abc123OrganizationID'

See code: src/commands/deployment/delete.ts

`spaces deployment:list`

List all of your deployments

USAGE
  $ spaces deployment:list

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  spaces deployment:list

See code: src/commands/deployment/list.ts

`spaces deployment:list-collections`

List all collections in a deployment

USAGE
  $ spaces deployment:list-collections

OPTIONS
  -h, --help                       show CLI help
  --id=id                          (required)
  --organizationId=organizationId  (required)

EXAMPLE
  spaces deployment:list-collections --id='abc123DeploymentID' --organizationId='abc123OrganizationID'

See code: src/commands/deployment/list-collections.ts

`spaces deployment:list-spaces`

List all spaces in a deployment

USAGE
  $ spaces deployment:list-spaces

OPTIONS
  -h, --help                       show CLI help
  --id=id                          (required)
  --organizationId=organizationId  (required)

EXAMPLE
  spaces deployment:list-spaces --id='abc123DeploymentID' --organizationId='abc123OrganizationID'

See code: src/commands/deployment/list-spaces.ts

`spaces deployment:read`

Read all properties of a deployment

USAGE
  $ spaces deployment:read

OPTIONS
  -h, --help                       show CLI help
  --id=id                          (required)
  --organizationId=organizationId  (required)

EXAMPLE
  spaces deployment:read --id='abc123DeploymentID'

See code: src/commands/deployment/read.ts

`spaces deployment:update`

Update one or more of a deployment's properties

USAGE
  $ spaces deployment:update

OPTIONS
  -h, --help                         show CLI help
  --id=id                            (required)
  --isGoogleIdentityProviderEnabled  (required)
  --name=name                        (required)
  --organizationId=organizationId    (required)

EXAMPLE
  spaces deployment:update --id='abc123OrganizationID' --isGoogleIdentityProviderEnabled --name='My Deployment'

See code: src/commands/deployment/update.ts

`spaces help [COMMAND]`

display help for spaces

USAGE
  $ spaces help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`spaces image:create`

Create a new image

USAGE
  $ spaces image:create

OPTIONS
  -h, --help                                                                                             show CLI help
  --description=description                                                                              (required)
  --icon=icon                                                                                            (required)
  --imageRepositoryUrl=imageRepositoryUrl                                                                (required)
  --imageTag=imageTag                                                                                    (required)
  --name=name                                                                                            (required)
  --organizationId=organizationId                                                                        (required)
  --recommendedContainerSize=recommendedContainerSize                                                    (required)
  --recommendedDockerPersistentStorageSizeInGigabytes=recommendedDockerPersistentStorageSizeInGigabytes  (required)
  --recommendedEnableDocker
  --recommendedEnableInboundClipboardRedirection
  --recommendedEnableOutboundClipboardRedirection
  --recommendedEnablePdfPrinter
  --recommendedEnablePersistentHome
  --recommendedInactivityTerminationDelayInMinutes=recommendedInactivityTerminationDelayInMinutes        (required)
  --recommendedPersistentHomeSizeInGigabytes=recommendedPersistentHomeSizeInGigabytes                    (required)
  --status=status                                                                                        (required)

EXAMPLE
  spaces image:create --description='This is a very good image.' --icon='base64imagecontent'
  --imageRepositoryUrl='https://my.registry.com/my/image' --imageTag='my.version'
  --organizationId='abc123OrganizationID' --status=LIVE

See code: src/commands/image/create.ts

`spaces image:delete`

Delete an image

USAGE
  $ spaces image:delete

OPTIONS
  -h, --help                       show CLI help
  --id=id                          (required)
  --organizationId=organizationId  (required)

EXAMPLE
  spaces image:delete --id='abc123ImageID' --organizationId='abc123OrganizationID'

See code: src/commands/image/delete.ts

`spaces image:list`

List all of your images

USAGE
  $ spaces image:list

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  spaces image:list

See code: src/commands/image/list.ts

`spaces image:read`

Read all properties of an image

USAGE
  $ spaces image:read

OPTIONS
  -h, --help                       show CLI help
  --id=id                          (required)
  --organizationId=organizationId  (required)

EXAMPLE
  spaces image:read --id='abc123ImageID' --organizationId='abc123OrganizationID'

See code: src/commands/image/read.ts

`spaces image:update`

Update an image's properties

USAGE
  $ spaces image:update

OPTIONS
  -h, --help                       show CLI help
  --description=description
  --icon=icon
  --id=id                          (required)
  --isPublic
  --organizationId=organizationId  (required)
  --status=status

EXAMPLE
  spaces image:update --id='abc123ImageID' --description='This is a very good image.' --icon='base64imagecontent'
  --organizationId='abc123OrganizationID' --status=LIVE

See code: src/commands/image/update.ts

`spaces login`

Generate & save an authentication token

USAGE
  $ spaces login

OPTIONS
  -h, --help  show CLI help

See code: src/commands/login.ts

`spaces logout`

Clear the saved authentication token

USAGE
  $ spaces logout

OPTIONS
  -h, --help  show CLI help

See code: src/commands/logout.ts

`spaces organization:add-admin`

Add someone to an organization's list of administrators

USAGE
  $ spaces organization:add-admin

OPTIONS
  -h, --help     show CLI help
  --email=email  (required)
  --id=id        (required)

EXAMPLE
  spaces organization:add-admin --id='abc123OrganizationID' --email='someone@example.com'

See code: src/commands/organization/add-admin.ts

`spaces organization:delete`

Delete an organization

USAGE
  $ spaces organization:delete

OPTIONS
  -h, --help  show CLI help
  --id=id     (required)

EXAMPLE
  spaces organization:delete --id='abc123OrganizationID'

See code: src/commands/organization/delete.ts

`spaces organization:list`

List all of your organizations

USAGE
  $ spaces organization:list

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  spaces organization:list

See code: src/commands/organization/list.ts

`spaces organization:list-collections`

List all collections in an organization

USAGE
  $ spaces organization:list-collections

OPTIONS
  -h, --help  show CLI help
  --id=id     (required)

EXAMPLE
  spaces organization:list-collections --id='abc123OrganizationID'

See code: src/commands/organization/list-collections.ts

`spaces organization:list-deployments`

List all deployments in an organization

USAGE
  $ spaces organization:list-deployments

OPTIONS
  -h, --help  show CLI help
  --id=id     (required)

EXAMPLE
  spaces organization:list-deployments --id='abc123OrganizationID'

See code: src/commands/organization/list-deployments.ts

`spaces organization:list-images`

List all images in an organization

USAGE
  $ spaces organization:list-images

OPTIONS
  -h, --help  show CLI help
  --id=id     (required)

EXAMPLE
  spaces organization:list-images --id='abc123OrganizationID'

See code: src/commands/organization/list-images.ts

`spaces organization:list-spaces`

List all spaces in an organization

USAGE
  $ spaces organization:list-spaces

OPTIONS
  -h, --help  show CLI help
  --id=id     (required)

EXAMPLE
  spaces organization:list-spaces --id='abc123OrganizationID'

See code: src/commands/organization/list-spaces.ts

`spaces organization:read`

Read all properties of an organization

USAGE
  $ spaces organization:read

OPTIONS
  -h, --help  show CLI help
  --id=id     (required)

EXAMPLE
  spaces organization:read --id='abc123OrganizationID'

See code: src/commands/organization/read.ts

`spaces organization:remove-admin`

Remove someone from an organization's list of administrators

USAGE
  $ spaces organization:remove-admin

OPTIONS
  -h, --help     show CLI help
  --email=email  (required)
  --id=id        (required)

EXAMPLE
  spaces organization:remove-admin --id='abc123OrganizationID' --email='someone@example.com'

See code: src/commands/organization/remove-admin.ts

`spaces organization:update`

Update an organization's name

USAGE
  $ spaces organization:update

OPTIONS
  -h, --help   show CLI help
  --id=id      (required)
  --name=name  (required)

EXAMPLE
  spaces organization:update --id='abc123OrganizationID' --name='My Organization'

See code: src/commands/organization/update.ts

`spaces space:delete`

Delete a space

USAGE
  $ spaces space:delete

OPTIONS
  -h, --help                   show CLI help
  --collectionId=collectionId  (required)
  --deploymentId=deploymentId  (required)
  --forceShutDownAllSessions
  --spaceId=spaceId            (required)

EXAMPLE
  spaces space:delete --collectionId='abc123CollectionID' --deploymentId='abc123DeploymentID' --forceShutDownAllSessions
  --spaceId='abc123SpaceID'

See code: src/commands/space/delete.ts

`spaces space:list`

List all of your spaces

USAGE
  $ spaces space:list

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  spaces space:list

See code: src/commands/space/list.ts

`spaces space:read`

Read all properties of a space

USAGE
  $ spaces space:read

OPTIONS
  -h, --help                   show CLI help
  --collectionId=collectionId  (required)
  --deploymentId=deploymentId  (required)
  --id=id                      (required)

EXAMPLE
  spaces space:read --id='abc123SpaceID' --collectionId='abc123CollectionID' --deploymentId='abc123DeploymentID'

See code: src/commands/space/read.ts

Name		Name	Last commit message	Last commit date
Latest commit History 88 Commits
.github/workflows		.github/workflows
.husky		.husky
bin		bin
src		src
.editorconfig		.editorconfig
.eslintignore		.eslintignore
.eslintrc		.eslintrc
.gitignore		.gitignore
.prettierrc.json		.prettierrc.json
LICENSE		LICENSE
README.md		README.md
codegen.yaml		codegen.yaml
mocha.opts		mocha.opts
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

License

itopia-inc/spaces-cli

Folders and files

Latest commit

History

Repository files navigation

Official CLI for itopia Spaces

Usage

Feedback

Build from source

Commands

spaces collection:add-end-user

spaces collection:delete

spaces collection:list

spaces collection:list-spaces

spaces collection:read

spaces collection:remove-end-user

spaces deployment:create

spaces deployment:delete

spaces deployment:list

spaces deployment:list-collections

spaces deployment:list-spaces

spaces deployment:read

spaces deployment:update

spaces help [COMMAND]

spaces image:create

spaces image:delete

spaces image:list

spaces image:read

spaces image:update

spaces login

spaces logout

spaces organization:add-admin

spaces organization:delete

spaces organization:list

spaces organization:list-collections

spaces organization:list-deployments

spaces organization:list-images

spaces organization:list-spaces

spaces organization:read

spaces organization:remove-admin

spaces organization:update

spaces space:delete

spaces space:list

spaces space:read

About

Resources