Skip to content

vn orgs

For users: the vn orgs commands. Browse and join organizations. Every command accepts --json to print its result as JSON for scripts and agents. This page is generated from the CLI’s own oclif manifest on every build, so it matches the published @venturenetwork/cli. Install it from The CLI.

Set or remove an organization cover photo, from a file or a link. Owners and admins only.

Terminal window
vn orgs cover SLUG [FILE] [flags]
Argument Required Description
SLUG yes Organization slug.
FILE no Path to a PNG, JPEG, WebP, or GIF, at most 5 MB. A wide photo works best.
Flag Type Description Default
--url option An image link to import a copy of, instead of a file.
--remove boolean Remove the current cover photo instead of uploading one.
Terminal window
vn orgs cover gt-vn ./cover.jpg
Terminal window
vn orgs cover gt-vn --url https://example.com/cover.jpg
Terminal window
vn orgs cover gt-vn --remove

List an organization’s invitations.

Terminal window
vn orgs invitations SLUG [flags]
Argument Required Description
SLUG yes Organization slug.
Flag Type Description Default
--limit option Maximum number of invitations to list. 25

Invite someone to an organization by email.

Terminal window
vn orgs invite SLUG EMAIL [flags]
Argument Required Description
SLUG yes Organization slug.
EMAIL yes Email address to invite.
Flag Type Description Default
--role option Role to invite them as. one of member, admin member
--expires-in-days option Days until the invitation expires. 14

Join an organization, or ask to join if it requires approval.

Terminal window
vn orgs join SLUG [flags]
Argument Required Description
SLUG yes Organization slug.
Flag Type Description Default
--message option A short message for the org owners, used only when the org requires approval.

List organizations.

Terminal window
vn orgs list [flags]
Flag Type Description Default
--mine boolean List only organizations you belong to.
--limit option Maximum number of organizations to list. 25

Set or remove an organization logo, from a file or a link. Owners and admins only.

Terminal window
vn orgs logo SLUG [FILE] [flags]
Argument Required Description
SLUG yes Organization slug.
FILE no Path to a PNG, JPEG, WebP, or GIF, at most 5 MB. Kept at its own proportions.
Flag Type Description Default
--url option An image link to import a copy of, instead of a file.
--remove boolean Remove the current logo instead of uploading one.
Terminal window
vn orgs logo gt-vn ./logo.png
Terminal window
vn orgs logo gt-vn --url https://example.com/logo.png
Terminal window
vn orgs logo gt-vn --remove

List an organization’s members.

Terminal window
vn orgs members SLUG [flags]
Argument Required Description
SLUG yes Organization slug.
Flag Type Description Default
--role option Filter the listed page by role. one of owner, admin, member
--limit option Maximum number of members to list. 25

Revoke a pending invitation.

Terminal window
vn orgs revoke SLUG ID
Argument Required Description
SLUG yes Organization slug.
ID yes Invitation id.

Show an organization.

Terminal window
vn orgs show SLUG
Argument Required Description
SLUG yes Organization slug.