Skip to content

Commit 23e951c

Browse files
seebirpietzsch
authored andcommitted
add cmemc group
1 parent 83d3725 commit 23e951c

3 files changed

Lines changed: 200 additions & 7 deletions

File tree

  • docs
    • automate/cmemc-command-line-interface/command-reference/package
    • develop/marketplace-packages
Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
---
2+
title: "cmemc: Command Group - package"
3+
description: "List, (un)install, export, create, or inspect packages."
4+
icon: material/shopping
5+
tags:
6+
- cmemc
7+
- Package
8+
---
9+
# package Command Group
10+
<!-- This file was generated - DO NOT CHANGE IT MANUALLY -->
11+
12+
List, (un)install, export, create, or inspect packages.
13+
14+
15+
## package create
16+
17+
Initialize an empty package directory with a minimal manifest.
18+
19+
```shell-session title="Usage"
20+
$ cmemc package create [OPTIONS] PACKAGE_ID
21+
```
22+
23+
24+
25+
26+
27+
??? info "Options"
28+
```text
29+
30+
--name TEXT The package name in english. Defaults to package ID.
31+
--version TEXT Semantic version identifier string of the package, but
32+
limited to proper releases. [default: 0.0.1]
33+
--description TEXT The package description in english. [default: This is
34+
the first version of a wonderful eccenca Corporate
35+
Memory package 🤓]
36+
```
37+
38+
## package inspect
39+
40+
Inspect the manifest of a package.
41+
42+
```shell-session title="Usage"
43+
$ cmemc package inspect [OPTIONS] PACKAGE_PATH
44+
```
45+
46+
47+
48+
49+
50+
??? info "Options"
51+
```text
52+
53+
--key TEXT Get a specific key only from the manifest.
54+
--raw Outputs raw JSON.
55+
```
56+
57+
## package list
58+
59+
List installed packages.
60+
61+
```shell-session title="Usage"
62+
$ cmemc package list [OPTIONS]
63+
```
64+
65+
66+
67+
68+
69+
??? info "Options"
70+
```text
71+
72+
--filter <TEXT TEXT>... Filter installed packages by one of the following
73+
filter names and a corresponding value: type, name,
74+
id.
75+
--id-only Lists only package IDs. This is useful for piping
76+
the IDs into other commands.
77+
--raw Outputs raw JSON.
78+
```
79+
80+
## package install
81+
82+
Install packages.
83+
84+
```shell-session title="Usage"
85+
$ cmemc package install [OPTIONS] [PACKAGE_ID]
86+
```
87+
88+
89+
90+
91+
This command installs a package either from the marketplace or from local package archives (.cpa) or directories.
92+
93+
94+
95+
??? info "Options"
96+
```text
97+
98+
-i, --input PATH Install a package from a package archive (.cpa) or
99+
directory.
100+
--replace Replace (overwrite) existing package version, if present.
101+
```
102+
103+
## package uninstall
104+
105+
Uninstall installed packages.
106+
107+
```shell-session title="Usage"
108+
$ cmemc package uninstall [OPTIONS] [PACKAGE_ID]
109+
```
110+
111+
112+
113+
114+
115+
??? info "Options"
116+
```text
117+
118+
--filter <TEXT TEXT>... Filter installed packages by one of the following
119+
filter names and a corresponding value: type, name,
120+
id.
121+
-a, --all Uninstall all packages. This is a dangerous option,
122+
so use it with care.
123+
```
124+
125+
## package export
126+
127+
Export installed packages to package directories.
128+
129+
```shell-session title="Usage"
130+
$ cmemc package export [OPTIONS] [PACKAGE_ID]
131+
```
132+
133+
134+
135+
136+
137+
??? info "Options"
138+
```text
139+
140+
--filter <TEXT TEXT>... Filter installed packages by one of the following
141+
filter names and a corresponding value: type, name,
142+
id.
143+
-a, --all Export all installed packages.
144+
--replace Replace (overwrite) existing files, if present.
145+
```
146+
147+
## package build
148+
149+
Build a package archive from a package directory.
150+
151+
```shell-session title="Usage"
152+
$ cmemc package build [OPTIONS] PACKAGE_DIRECTORY
153+
```
154+
155+
156+
157+
158+
This command processes a package directory, validates its content including the manifest, and creates a versioned Corporate Memory package archive (.cpa) with the following naming convention: {package_id}-v{version}.cpa
159+
160+
Package archives can be published to the marketplace using the `package publish` command.
161+
162+
163+
164+
??? info "Options"
165+
```text
166+
167+
--version TEXT Set the package version.
168+
--replace Replace package archive, if present.
169+
--output-dir DIRECTORY Create the package archive in a specific directory.
170+
[default: .]
171+
```
172+
173+
## package publish
174+
175+
Publish a package archive to the marketplace server.
176+
177+
```shell-session title="Usage"
178+
$ cmemc package publish [OPTIONS] PACKAGE_ARCHIVE
179+
```
180+
181+
182+
183+
184+
185+
??? info "Options"
186+
```text
187+
188+
--marketplace-url TEXT Alternative Marketplace URL.
189+
```
190+

docs/develop/marketplace-packages/development/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ Use the [package-template](https://github.com/eccenca/cmem-package-template) to
2828

2929
Packages without a license declaration cannot be published to a Corporate Memory Marketplace Server.
3030

31-
Our template will bootstrap with an _Apache License 2.0 ([`Apache-2.0`](https://spdx.org/licenses/Apache-2.0.html))_. See <https://spdx.org/licenses/> if you need a different license.
31+
Our template will bootstrap your package with an _Apache License 2.0 ([`Apache-2.0`](https://spdx.org/licenses/Apache-2.0.html))_.
32+
See <https://spdx.org/licenses/> if you need a different license.
3233
You can remove a license entirely; however, a package that does not declare a license cannot be published.
3334

3435
### Manifest

docs/develop/marketplace-packages/installation/index.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,42 +8,44 @@ tags:
88

99
## Introduction
1010

11-
Marketplace Packages can be installed directly from a Corporate Memory Marketplace Server or from local package archives (`.cpa` files).
11+
Marketplace Packages can be installed directly from a Corporate Memory Marketplace Server (e.g. [https://eccenca.market](https://eccenca.market)), or from local **C**orporate Memory **P**ackage **A**rchives (`.cpa` files).
1212

1313
This page describes how to install, list, and uninstall packages using `cmemc`.
1414

1515
!!! info "`cmemc package` reference"
1616

17-
Refer to [TODO: link](./) for the complete reference of the `package` command group.
17+
The [cmemc package command group](../../../automate/cmemc-command-line-interface/command-reference/package/index.md) contains of a needed commands to support
18+
the complate package lifecycle.
1819

1920
## Install Packages
2021

2122
Use the following command to install a package from a Marketplace Server:
2223

23-
```sh
24+
``` sh
2425
cmemc package install PACKAGE_ID
2526
```
2627

2728
For installing local package archives (`.cpa` files) or package directories, use the `--input` option:
2829

29-
```sh
30+
``` sh
3031
cmemc package install --input PATH
3132
```
3233

3334
## List Packages
3435

3536
Use the following command to list all installed packages:
3637

37-
```sh
38+
``` sh
3839
cmemc package list
3940
```
4041

4142
## Uninstall Packages
4243

4344
Use the following command to uninstall a package:
4445

45-
```sh
46+
``` sh
4647
cmemc package uninstall PACKAGE_ID
4748
```
4849

4950
This removes all package contents from the Corporate Memory instance, including graphs and Build projects that were installed as part of the package.
51+

0 commit comments

Comments
 (0)