CLI

Building

Build the CLI binary from source:

crystal build src/cli.cr -o bin/spdx

Or use the shard target:

shards build

Commands

spdx expression parse

Parse a license expression and display the AST:

$ spdx expression parse "MIT AND Apache-2.0"
Expression: MIT AND Apache-2.0
Parsed:     MIT AND Apache-2.0
AND:
  License: MIT
  License: Apache-2.0

$ spdx expression parse "GPL-2.0-only WITH Classpath-exception-2.0 OR MIT"
Expression: GPL-2.0-only WITH Classpath-exception-2.0 OR MIT
Parsed:     GPL-2.0-only WITH Classpath-exception-2.0 OR MIT
OR:
  WITH:
    License: GPL-2.0-only
    Exception: Classpath-exception-2.0
  License: MIT

spdx expression validate

Validate an expression against the SPDX license list:

$ spdx expression validate "MIT AND Apache-2.0"
Expression: MIT AND Apache-2.0
Valid:      yes

$ spdx expression validate "MIT AND FakeLicense"
Expression: MIT AND FakeLicense
Valid:      yes
Warnings:
  - Unknown license: FakeLicense

spdx license list

List SPDX licenses with optional filters:

$ spdx license list
$ spdx license list --osi    # OSI-approved only
$ spdx license list --fsf    # FSF libre only

spdx license info

Show details for a specific license:

$ spdx license info MIT
ID:           MIT
Name:         MIT License
OSI Approved: yes
FSF Libre:    yes
Deprecated:   no

Search licenses by ID or name:

$ spdx license search apache
ID                             Name
--------------------------------------------------------------------------------
Apache-1.0                     Apache License 1.0
Apache-1.1                     Apache License 1.1
Apache-2.0                     Apache License 2.0

Found: 3 licenses

spdx validate

Validate an SPDX document (JSON or Tag-Value):

$ spdx validate document.spdx.json
document.spdx.json: Valid SPDX document
  Version:   SPDX-2.3
  Name:      Example
  Namespace: https://example.org/example
  Packages:  1
  Files:     1
  Relations: 2

spdx convert

Convert between SPDX formats:

# Tag-Value to JSON
$ spdx convert document.spdx --format json

# JSON to Tag-Value
$ spdx convert document.spdx.json --format tv

spdx version

$ spdx version
spdx 0.1.0

Powered by Hwaro