magma-shell

This is a console/shell tool for Magma.

Use cases:

• Access magma data via shell scripts
• Automate your magma workflow
• Have convenient shell access for programmers
• Anything you would want to do via API but time-to-value is of the essence
• Mirror all data from a specific project to a local directory
• Mirror do GDrive, Dropbox etc. (with additional external tools)
• (Fun) display images directly in the shell (via magma shell)

Requirements

• Paid team account on public, private or self-hosted Magma instance
• Working installation of Node.JS version 18 or higher

Installation instructions

npm install -g magma-shell

Running:

magma
# and then follow the steps to set up API access and server address

magma --help

Running commands

You can either run commands from within the magma-shell:

alice@AlicePC$ magma
Welcome Alice to magma CLI tool. Type "help" for a list of commands.
@Alice> profile
Alice <[email protected]>
@Alice>

or run within your shell such as bash/ZSH or others

alice@AlicePC$ magma profile
Alice <[email protected]>

Commands

Command help

Display help

Command profile

Display currently logged in user

Command project

Change current scope to another project of the currently selected team

Parameters

project <projectIdOrName>

Command cd

Change current folder or reset to root when no argument is passed

Parameters

cd <folderIdOrName>

Command mkdir

Create new folder

Parameters

mkdir <newFolderName>

Command create

Create entity (Drawing, or Folder)

Parameters

create <type>

Command rename

Rename entity

Parameters

rename <entityIdOrName>

Command rm

Delete entity (run with -f or --force for deleting non-empty folders)

Parameters

rm <entityIdOrName>

Command ls

List entities in the current or the specified folder

Parameters

ls <folderIdOrName>

Command download

Download a remote entity in a given format to the local directory

Parameters

download <idOrName> <format>

Command projects

List all projects of the selected team

Command team

Select active team scope. Run with no arguments to reset to private scope.

Parameters

team <teamIdOrSlugOrName>

Command teams

List all teams and projects

Command upload

Upload a local drawing

Parameters

upload <localFileOnDisk>

Command mirror

Mirror entire project to a local folder on disk. Intelligently tracks which entities were modified from the previous run

Parameters

mirror <targetPathOnDisk> <format (png, psd, jpg)>

Command mv

Move entity to another directory

Parameters

mv <sourceIdOrName> <targetFolderIdOrName>

Command open

Open entity in the web browser (you need to be logged in as the same user as in the shell)

Parameters

open <sourceIdOrName>

Command openLocal

Open item in a local application associated with the PSD extension

Parameters

openLocal <idOrName> <appName>

Command show

View item directly in the shell (quality depends on your terminal)

Parameters

show <idOrName>

License

All examples and public code are available under the MIT license.

Copyright (c) Magma