Skip to main content

Kommandozeilenbefehle c4-cli library

Manipulation von Bibliotheksreferenzen

Verwendung:

  c4-cli library [OPTIONS] <COMMAND>
Beispiel 24. Beispiele
    c4-cli library set-managed ToolsNamespace "AcmeTools, 1.2.3.4 (Acme Inc)" C:/path/to/Libraries.json --optional true
    c4-cli library set-managed ToolsNamespace "AcmeTools, 1.2.3.4 (Acme Inc)" C:/path/to/Application.iecapp/ --optional true
    c4-cli library set-relative ToolsNamespace C:/path/to/library.fbslib/ C:/path/to/Libraries.json
    c4-cli library set-placeholder ToolsNamespace some_placeholder C:/path/to/Libraries.json
    c4-cli library restore


Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

Kommando

Beschreibung

set-managed <namespace> <library>

Hinzufügen einer neuen Referenz auf eine verwaltete Bibliothek zur Datei Libraries.json oder Ersetzen einer bestehenden Referenz

set-relative <namespace> <path>

Hinzufügen einer neuen Referenz auf einen relativen Pfad zur Datei Libraries.json oder Ersetzen einer bestehenden Referenz

set-placeholder <namespace> <placeholder>

Hinzufügen einer neuen Platzhalterreferenz zur Datei Libraries.json oder Ersetzen einer bestehenden Referenz

install

Auflösen aller Bibliotheken einer Applikation und Laden der fehlenden Bibliotheken in den Bibliotheks-Cache

install-placeholder <namespace> <placeholder>

Hinzufügen einer neuen Referenz auf einen Platzhalter zur Datei Libraries.json oder Ersetzen einer bestehenden Referenz. Löst anschließend alle Bibliotheken der Applikation auf und stellt fehlende Bibliotheken im Bibliotheks-Cache wieder her

install-managed <namespace> <library>

Hinzufügen einer neuen Referenz auf eine verwaltete Bibliothek zur Datei Libraries.json oder Ersetzen einer bestehenden Referenz. Löst anschließend alle Bibliotheken der Applikation auf und stellt fehlende Bibliotheken im Bibliotheks-Cache wieder her

install-relative <namespace> <path>

Hinzufügen einer neuen Referenz auf einen relativen Pfad zur Datei Libraries.json oder Ersetzen einer bestehenden Referenz. Löst anschließend alle Bibliotheken der Applikation auf und stellt fehlende Bibliotheken im Bibliotheks-Cache wieder her

restore

Wiederherstellen aller fehlenden Bibliotheken einer Applikation im Bibliotheks-Cache

clean-install

Überprüfen der Libraries.lock.json-Dateien, Löschen des Bibliotheks-Caches und Installieren aller Bibliotheken, auf die in den Libraries.lock.json-Dateien verwiesen wird

library uninstall <namespace> [target-path]

Deinstallieren der einem gegebenen Namensraum zugeordneten Bibliothek. Entfernen der Bibliothek selbst sowie aller Abhängigkeiten, auf die ausschließlich diese Bibliothek verweist

resolve

Auflösen der Bibliotheksreferenzen für eine bestimmte Applikation auf und Schreiben in die Datei Libraries.lock.json

remove <namespace> [target-path]

Entfernen der durch den Namensraum identifizierten Bibliotheksreferenz aus der Libraries.json

prune

Entfernen ungenutzter indirekter Referenzen auf Bibliotheken aus der Libraries.lock.json

outdated

Überprüfen der Repositorys, um festzustellen, ob installierte Bibliotheken (allgemein oder spezifisch) derzeit veraltet sind

list

Auflisten aller Referenzen zu einer angegebenen Applikation

explain <library>

Ausgabe der Abhängigkeitskette, die dazu führt, dass eine bestimmte Bibliothek referenziert wird

pack

Erstellen eines Quellbibliotheksarchivs aus dem angegebenen CODESYS 4-Bibliotheks-Projektordner. Es muss sich um eine gültige Bibliothek handeln.

save-compiled <library-path> <destination-path>

Speichern der angegebenen Bibliothek als kompilierte Bibliothek

verify

Überprüfen, ob die Bibliotheksauflösungen in der Libraries.lock.json noch gültig sind und weiterhin mit der Libraries.json übereinstimmen. Prüft, ob alle Bibliotheken im Bibliotheks-Cache zugänglich sind und ob keine doppelten Referenzen, aktualisierten Packages oder verwaisten Einträge vorhanden sind

check

Prüft das Bibliotheksprojekt und meldet alle gefundenen Fehler und Warnungen

Kommandozeilenbefehl c4-cli library set-managed

Hinzufügen einer neuen Referenz auf eine verwaltete Bibliothek zur Datei Libraries.json oder Ersetzen einer bestehenden Referenz

Verwendung:

c4-cli library set-managed <namespace> <library> [target-path] [OPTIONS]
Beispiel 25. Beispiele
c4-cli library set-managed ToolsNamespace "AcmeTools, 1.2.3.4 (Acme Inc)" C:/path/to/Libraries.json --optional true
c4-cli library set-managed ToolsNamespace "AcmeTools, 1.2.3.4 (Acme Inc)" C:/path/to/Application.iecapp/ --optional true


Argumente

Beschreibung

<namespace>

Der Namensraum der Bibliothek, die bearbeitet werden soll

<library>

Die Bibliotheks-ID oder das Muster der hinzuzufügenden Bibliothek

[target-path]

Ein Pfad zu einer Libraries.json-Datei, einem Applikationsverzeichnis oder einem Bibliotheksverzeichnis, in dem die Referenz erstellt oder ersetzt wird. Wenn dies weggelassen wird, verwendet der Befehl standardmäßig das aktuelle Verzeichnis.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-u, --allow-unqualified-access

Wenn dies auf true gesetzt ist, kann auf die Bibliothek ohne Namespace-Qualifizierung zugegriffen werden. Der empfohlene Wert für neuen Code ist false. Dies entspricht der Negation des Werts qualifiedOnly in CODESYS 3, der aus historischen Gründen standardmäßig auf false gesetzt ist.

-c, --publish-symbols-in-container

Wenn dies auf true gesetzt ist, veröffentlicht die referenzierte Bibliothek ihre Symbole in der referenzierenden Container-Bibliothek. Verwenden Sie diese Einstellung, um die veröffentlichten Symbole beim Erstellen einer Container-Bibliothek zu definieren.

-o, --optional

Wenn dies auf true gesetzt ist, treten keine Compilerfehler allein dadurch auf, dass die Bibliothek nicht verfügbar ist. (Es können jedoch Compilerfehler durch fehlende Symbole aus dieser Bibliothek auftreten.)

--no-hash

Gilt für relative Pfadreferenzen, die auf Dateien (.zip oder .compiled-library) verweisen. Unterdrückt die Generierung von SHA384-Hash-Werten in der Libraries.lock.json. Dies ist nützlich in Build- und Test-CI-Pipelines, wenn die referenzierte Datei früher in der Pipeline generiert wird und ein sich ändernder Hash erwartet wird.

-p, --include-prerelease

Wenn dies auf true gesetzt ist, stimmen Versionsmuster immer mit Vorabversionen innerhalb des zulässigen Bereichs überein. Andernfalls gilt das Standardverhalten: Wenn eine Version ein Vorabversions-Tag hat (zum Beispiel 1.2.3-alpha.3), darf sie Komparatorsätze nur dann erfüllen, wenn mindestens ein Komparator mit demselben [major, minor, patch]-Tupel ebenfalls ein Vorabversions-Tag hat.

--link-all-content

Nur für spezielle Anwendungsfälle: Wenn dies auf true gesetzt ist, wird die gesamte Bibliothek eingebunden, nicht nur die referenzierten Teile.

--default-resolution

Optional, für Platzhalter zulässig. Wenn das Flag gesetzt ist, muss dies eine Bibliotheks-ID oder ein Muster sein, die oder das bei der Bibliotheksprüfung verwendet wird.

-d, --dry-run

Optional. Wenn das Flag gesetzt ist, werden keine Änderungen an den Dateien vorgenommen, stattdessen wird der Eintrag, der geschrieben würde, auf der Konsole ausgegeben.

Kommandozeilenbefehl c4-cli library set-relative

Hinzufügen einer neuen Referenz auf einen relativen Pfad zur Datei Libraries.json oder Ersetzen einer bestehenden Referenz

Verwendung:

c4-cli library set-relative <namespace> <path> [target-path] [OPTIONS]
Beispiel 26. Beispiele
    c4-cli library set-relative ToolsNamespace C:/path/to/library.fbslib/ C:/path/to/Libraries.json


Argumente

Beschreibung

<namespace>

Der Namensraum der Bibliothek, die bearbeitet werden soll

<path>

Der Pfad zum (gepackten) Bibliotheksprojekt oder zur kompilierten Bibliothek, die hinzugefügt werden soll

[target-path]

Ein Pfad zu einer Libraries.json-Datei, einem Applikationsverzeichnis oder einem Bibliotheksverzeichnis, in dem die Referenz erstellt oder ersetzt wird. Wenn dies weggelassen wird, verwendet der Befehl standardmäßig das aktuelle Verzeichnis.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-u, --allow-unqualified-access

Wenn dies auf true gesetzt ist, kann auf die Bibliothek ohne Namespace-Qualifizierung zugegriffen werden. Der empfohlene Wert für neuen Code ist false. Dies entspricht der Negation des Werts qualifiedOnly in CODESYS 3, der aus historischen Gründen standardmäßig auf false gesetzt ist.

-c, --publish-symbols-in-container

Wenn dies auf true gesetzt ist, veröffentlicht die referenzierte Bibliothek ihre Symbole in der referenzierenden Container-Bibliothek. Verwenden Sie diese Einstellung, um die veröffentlichten Symbole beim Erstellen einer Container-Bibliothek zu definieren.

-o, --optional

Wenn dies auf true gesetzt ist, treten keine Compilerfehler allein dadurch auf, dass die Bibliothek nicht verfügbar ist. (Es können jedoch Compilerfehler durch fehlende Symbole aus dieser Bibliothek auftreten.)

--no-hash

Gilt für relative Pfadreferenzen, die auf Dateien (.zip oder .compiled-library) verweisen. Unterdrückt die Generierung von SHA384-Hash-Werten in der Libraries.lock.json. Dies ist nützlich in Build- und Test-CI-Pipelines, wenn die referenzierte Datei früher in der Pipeline generiert wird und ein sich ändernder Hash erwartet wird.

-p, --include-prerelease

Wenn dies auf true gesetzt ist, stimmen Versionsmuster immer mit Vorabversionen innerhalb des zulässigen Bereichs überein. Andernfalls gilt das Standardverhalten: Wenn eine Version ein Vorabversions-Tag hat (zum Beispiel 1.2.3-alpha.3), darf sie Komparatorsätze nur dann erfüllen, wenn mindestens ein Komparator mit demselben [major, minor, patch]-Tupel ebenfalls ein Vorabversions-Tag hat.

--link-all-content

Nur für spezielle Anwendungsfälle: Wenn dies auf true gesetzt ist, wird die gesamte Bibliothek eingebunden, nicht nur die referenzierten Teile.

--default-resolution

Optional, für Platzhalter zulässig. Wenn das Flag gesetzt ist, muss dies eine Bibliotheks-ID oder ein Muster sein, die oder das bei der Bibliotheksprüfung verwendet wird.

-d, --dry-run

Optional. Wenn das Flag gesetzt ist, werden keine Änderungen an den Dateien vorgenommen, stattdessen wird der Eintrag, der geschrieben würde, auf der Konsole ausgegeben.

Kommandozeilenbefehl c4-cli library set-placeholder

Hinzufügen einer neuen Platzhalterreferenz zur Datei Libraries.json oder Ersetzen einer bestehenden Referenz.

Verwendung:

c4-cli library set-placeholder <namespace> <placeholder> [target-path] [OPTIONS]
Beispiel 27. Beispiele
    c4-cli library set-placeholder ToolsNamespace some_placeholder C:/path/to/Libraries.json


Argumente

Beschreibung

<namespace>

Der Namensraum der Bibliothek, die bearbeitet werden soll

<placeholder>

Der Platzhalter für die hinzuzufügende Bibliothek

[target-path]

Ein Pfad zu einer Libraries.json-Datei, einem Applikationsverzeichnis oder einem Bibliotheksverzeichnis, in dem die Referenz erstellt oder ersetzt wird. Wenn dies weggelassen wird, verwendet der Befehl standardmäßig das aktuelle Verzeichnis.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-u, --allow-unqualified-access

Wenn dies auf true gesetzt ist, kann auf die Bibliothek ohne Namespace-Qualifizierung zugegriffen werden. Der empfohlene Wert für neuen Code ist false. Dies entspricht der Negation des Werts qualifiedOnly in CODESYS 3, der aus historischen Gründen standardmäßig auf false gesetzt ist.

-c, --publish-symbols-in-container

Wenn dies auf true gesetzt ist, veröffentlicht die referenzierte Bibliothek ihre Symbole in der referenzierenden Container-Bibliothek. Verwenden Sie diese Einstellung, um die veröffentlichten Symbole beim Erstellen einer Container-Bibliothek zu definieren.

-o, --optional

Wenn dies auf true gesetzt ist, treten keine Compilerfehler allein dadurch auf, dass die Bibliothek nicht verfügbar ist. (Es können jedoch Compilerfehler durch fehlende Symbole aus dieser Bibliothek auftreten.)

--no-hash

Gilt für relative Pfadreferenzen, die auf Dateien (.zip oder .compiled-library) verweisen. Unterdrückt die Generierung von SHA384-Hash-Werten in der Libraries.lock.json. Dies ist nützlich in Build- und Test-CI-Pipelines, wenn die referenzierte Datei früher in der Pipeline generiert wird und ein sich ändernder Hash erwartet wird.

-p, --include-prerelease

Wenn dies auf true gesetzt ist, stimmen Versionsmuster immer mit Vorabversionen innerhalb des zulässigen Bereichs überein. Andernfalls gilt das Standardverhalten: Wenn eine Version ein Vorabversions-Tag hat (zum Beispiel 1.2.3-alpha.3), darf sie Komparatorsätze nur dann erfüllen, wenn mindestens ein Komparator mit demselben [major, minor, patch]-Tupel ebenfalls ein Vorabversions-Tag hat.

--link-all-content

Nur für spezielle Anwendungsfälle: Wenn dies auf true gesetzt ist, wird die gesamte Bibliothek eingebunden, nicht nur die referenzierten Teile.

--default-resolution

Optional, für Platzhalter zulässig. Wenn das Flag gesetzt ist, muss dies eine Bibliotheks-ID oder ein Muster sein, die oder das bei der Bibliotheksprüfung verwendet wird.

-d, --dry-run

Optional. Wenn das Flag gesetzt ist, werden keine Änderungen an den Dateien vorgenommen, stattdessen wird der Eintrag, der geschrieben würde, auf der Konsole ausgegeben.

Kommandozeilenbefehl c4-cli library install

Auflösen aller Bibliotheken einer Applikation und Laden der fehlenden Bibliotheken in den Bibliotheks-Cache

Verwendung:

c4-cli library install [target-path] [OPTIONS]
Beispiel 28. Beispiele
    c4-cli library i    
    c4-cli library install
    c4-cli library install C:/path/to/application.iecapp


Argumente

Beschreibung

[target-path]

Pfad zum Verzeichnis einer bestimmten Applikation, in deren Kontext der Befehl ausgeführt werden soll. Wenn das Flag nicht gesetzt ist, verwendet der Befehl standardmäßig das aktuelle Verzeichnis. Gültige Ziele sind ein Applikationsverzeichnis, eine Datei Libraries.json oder eine Datei Libraries.lock.json.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-d, --dry-run

Optional. Wenn das Flag gesetzt ist, meldet der Befehl auf die übliche Weise, welche Änderungen bei der Ausführung vorgenommen worden wären. Das Dateisystem wird jedoch nicht verändert.

Kommandozeilenbefehl c4-cli library install-placeholder

Hinzufügen einer neuen Referenz auf einen Platzhalter zur Datei Libraries.json oder Ersetzen einer bestehenden Referenz. Löst anschließend alle Bibliotheken der Applikation auf und stellt fehlende Bibliotheken im Bibliotheks-Cache wieder her

Verwendung:

c4-cli library install-placeholder <namespace> <placeholder> [target-path] [OPTIONS]
Beispiel 29. Beispiele
    c4-cli library install-placeholder SomeOtherNamespace some_placeholder C:/path/to/application.iecapp


Argumente

Beschreibung

<namespace>

Namensraum einer einzelnen bestimmten Bibliothek, die installiert werden soll. Wenn dieses Argument angegeben wird, müssen Sie auch ein Argument für library angeben.

<placeholder>

Der Platzhalter der Bibliothek, die hinzugefügt wird

[target-path]

Pfad zum Verzeichnis einer bestimmten Applikation, in deren Kontext der Befehl ausgeführt werden soll. Wenn das Flag nicht gesetzt ist, verwendet der Befehl standardmäßig das aktuelle Verzeichnis. Gültige Ziele sind ein Applikationsverzeichnis, eine Datei Libraries.json oder eine Datei Libraries.lock.json.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-d, --dry-run

Optional. Wenn das Flag gesetzt ist, meldet der Befehl auf die übliche Weise, welche Änderungen bei der Ausführung vorgenommen worden wären. Das Dateisystem wird jedoch nicht verändert.

Kommandozeilenbefehl c4-cli library install-managed

Hinzufügen einer neuen Referenz auf eine verwaltete Bibliothek zur Datei Libraries.json oder Ersetzen einer bestehenden Referenz. Löst anschließend alle Bibliotheken der Applikation auf und stellt fehlende Bibliotheken im Bibliotheks-Cache wieder her.

Verwendung:

c4-cli library install-managed <namespace> <library> [target-path] [OPTIONS]
Beispiel 30. Beispiele
    c4-cli library install-managed ToolsNamespace "AcmeTools, 1.2.3.4 (Acme Inc)" C:/path/to/application.iecapp


Argumente

Beschreibung

<namespace>

Der Namensraum einer einzelnen, spezifischen Bibliothek, die installiert werden soll. Das Flag muss bei der Installation einer einzelnen, spezifischen Bibliothek angegeben werden.

<library>

Die Bibliotheks-ID oder das Muster der hinzuzufügenden Bibliothek

[target-path]

Pfad zum Verzeichnis einer bestimmten Applikation, in deren Kontext der Befehl ausgeführt werden soll. Wenn das Flag nicht gesetzt ist, verwendet der Befehl standardmäßig das aktuelle Verzeichnis. Gültige Ziele sind ein Applikationsverzeichnis, eine Datei Libraries.json oder eine Datei Libraries.lock.json.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-d, --dry-run

Optional. Wenn das Flag gesetzt ist, meldet der Befehl auf die übliche Weise, welche Änderungen bei der Ausführung vorgenommen worden wären. Das Dateisystem wird jedoch nicht verändert.

Kommandozeilenbefehl c4-cli library install-relative

Hinzufügen einer neuen Referenz auf einen relativen Pfad zur Datei Libraries.json oder Ersetzen einer bestehenden Referenz. Löst anschließend alle Bibliotheken der Applikation auf und stellt fehlende Bibliotheken im Bibliotheks-Cache wieder her

Verwendung:

c4-cli library install-relative <namespace> <path> [target-path] [OPTIONS]
Beispiel 31. Beispiele
    c4-cli library install-relative ToolsNamespace ../some/relative/library.fbslib C:/path/to/application.iecapp


Argumente

Beschreibung

<namespace>

Namensraum einer einzelnen bestimmten Bibliothek, die installiert werden soll. Wenn dieses Argument angegeben wird, müssen Sie auch ein Argument für library angeben.

<path>

Der Pfad zum (gepackten) Bibliotheksprojekt oder zur kompilierten Bibliothek, die hinzugefügt werden soll

[target-path]

Pfad zum Verzeichnis einer bestimmten Applikation, in deren Kontext der Befehl ausgeführt werden soll. Wenn das Flag nicht gesetzt ist, verwendet der Befehl standardmäßig das aktuelle Verzeichnis. Gültige Ziele sind ein Applikationsverzeichnis, eine Datei Libraries.json oder eine Datei Libraries.lock.json.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-d, --dry-run

Optional. Wenn das Flag gesetzt ist, meldet der Befehl auf die übliche Weise, welche Änderungen bei der Ausführung vorgenommen worden wären. Das Dateisystem wird jedoch nicht verändert.

Kommandozeilenbefehl c4-cli library restore

Wiederherstellen aller fehlenden Bibliotheken einer Applikation im Bibliotheks-Cache

Verwendung:

c4-cli library restore [target-path] [library-id] [OPTIONS]
Beispiel 32. Beispiele
    c4-cli library restore
    c4-cli library restore "AcmeTools, 1.2.3.4 (Acme Inc)"


Argumente

Beschreibung

[target-path]

Pfad zum Verzeichnis einer bestimmten Applikation, in deren Kontext der Befehl ausgeführt werden soll. Wenn das Flag nicht gesetzt ist, verwendet der Befehl standardmäßig das aktuelle Verzeichnis. Gültige Ziele sind ein Applikationsverzeichnis, eine Datei Libraries.json oder eine Datei Libraries.lock.json.

[library-id]

Wenn angegeben, wird nur die spezifizierte Bibliothek wiederhergestellt (sofern sie nicht bereits im Cache vorhanden ist).

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-d, --dry-run

Optional. Wenn das Flag gesetzt ist, meldet der Befehl auf die übliche Weise, welche Änderungen bei der Ausführung vorgenommen worden wären. Das Dateisystem wird jedoch nicht verändert.

Kommandozeilenbefehl c4-cli library clean-install

Überprüfen der Libraries.lock.json-Dateien, Löschen des Bibliotheks-Caches und Installieren aller Bibliotheken, auf die in den Libraries.lock.json-Dateien verwiesen wird

Verwendung:

c4-cli library clean-install [target-path] [OPTIONS]
Beispiel 33. Beispiele
    c4-cli library clean-install
    c4-cli library ci C:/path/to/application.iecapp/
    c4-cli library ci C:/path/to/device.fbsdev/ --dry-run


Argumente

Beschreibung

[target-path]

Pfad zum Verzeichnis eines spezifischen Geräteprojekts, in dessen Kontext der Befehl ausgeführt werden soll. Wenn kein Wert angegeben ist, verwendet der Befehl standardmäßig das aktuelle Verzeichnis. Gültige Ziele sind ein Geräteprojektverzeichnis, ein Applikationsverzeichnis, eine Datei Libraries.json oder eine Datei Libraries.lock.json.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-d, --dry-run

Optional. Wenn das Flag gesetzt ist, meldet der Befehl auf die übliche Weise, welche Änderungen bei der Ausführung vorgenommen worden wären. Das Dateisystem wird jedoch nicht verändert.

Kommandozeilenbefehl c4-cli library uninstall

Deinstalliert die einem gegebenen Namensraum zugeordnete Bibliothek und entfernt dabei die Bibliothek selbst sowie alle Abhängigkeiten, auf die diese Bibliothek exklusiv verweist

Verwendung:

c4-cli library uninstall <namespace> [target-path] [OPTIONS]
Beispiel 34. Beispiele:
c4-cli library uninstall LibraryNamespace
c4-cli library uninstall LibraryNamespace C:/path/to/Libraries.json
c4-cli library uninstall LibraryNamespace C:/path/to/Libraries.lock.json
c4-cli library uninstall LibraryNamespace C:/path/to/Application.iecapp


Argumente

Beschreibung

<namespace>

Der Namensraum der Bibliothek, die deinstalliert wird

[target-path]

Pfad zu einer Libraries.json- oder Libraries.lock.json-Datei oder zu einem Applikationsverzeichnis, auf das der Uninstall-Befehl angewendet werden soll. Wenn dies weggelassen wird, verwendet der Befehl standardmäßig das aktuelle Verzeichnis.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-d, --dry-run

Optional. Es werden keine Änderungen an Dateien vorgenommen, nur die Fortschrittsprotokolle des Befehls werden auf der Konsole ausgegeben.

Kommandozeilenbefehl c4-cli library resolve

Auflösen der Bibliotheksreferenzen für eine bestimmte Applikation auf und Schreiben in die Datei Libraries.lock.json

Verwendung:

c4-cli library resolve [target-path] [namespace] [OPTIONS]
Beispiel 35. Beispiele:
    c4-cli library resolve C:/path/to/Project.fbsdev/Application.iecapp/
    c4-cli library resolve C:/path/to/Project.fbsdev/Application.iecapp/ LibraryNamespace
    c4-cli library resolve C:/path/to/Project.fbsdev/Application.iecapp/ --all


Argumente

Beschreibung

[target-path]

Pfad zum Verzeichnis einer spezifischen Applikation, in deren Kontext der Befehl ausgeführt werden soll. Wenn kein Wert angegeben ist, verwendet der Befehl standardmäßig das aktuelle Verzeichnis. Gültige Ziele sind ein Applikationsverzeichnis, ein Bibliotheksprojektverzeichnis, eine Datei Libraries.json oder eine Datei Libraries.lock.json.

[namespace]

Wenn dieses Argument angegeben wird, wird nur der angegebene Namensraum aufgelöst und nur die aufgelöste Bibliothek in der Lock-Datei aktualisiert.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Setzen auf einen beliebigen gültigen Loglevel. Wenn das Flag nicht angegeben ist, ist das Logging deaktiviert.

-d, --dry-run

Optional. Wenn das Flag gesetzt ist, meldet der Befehl auf die übliche Weise, welche Änderungen bei der Ausführung vorgenommen worden wären. Das Dateisystem wird jedoch nicht verändert.

-a, --all

Wenn das Flag gesetzt ist, wird die aktuelle Libraries.lock.json verworfen und eine vollständig neue geschrieben.

Kommandozeilenbefehl c4-cli library remove

Entfernen der durch den Namensraum identifizierten Bibliotheksreferenz aus der Libraries.json

Verwendung:

c4-cli library remove <namespace> [target-path] [OPTIONS]
Beispiel 36. Beispiele:
c4-cli library remove ToolsNamespace C:/path/to/Libraries.json 


Argumente

Beschreibung

<namespace>

Der Namensraum der Bibliothek, die entfernt werden soll

[target-path]

Ein Pfad zu einer Libraries.json-Datei, einem Applikationsverzeichnis oder einem Bibliotheksverzeichnis, aus dem die Referenz entfernt wird. Wenn dies weggelassen wird, verwendet der Befehl standardmäßig das aktuelle Verzeichnis.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Setzen auf einen beliebigen gültigen Loglevel. Wenn das Flag nicht angegeben ist, ist das Logging deaktiviert.

Kommandozeilenbefehl c4-cli library prune

Entfernt ungenutzte indirekte Verweise auf Bibliotheken aus der Libraries.lock.json

Verwendung:

c4-cli library prune [target-path] [OPTIONS]
Beispiel 37. Beispiele:
c4-cli library prune C:/path/to/Libraries.lock.json


Argumente

Beschreibung

[target-path]

Der Pfad zum Ziel des Befehls. Wird dies weggelassen, verwendet der Befehl standardmäßig das aktuelle Verzeichnis. Gültige Ziele sind ein Applikationsverzeichnis, eine Libraries.json-Datei oder eine Libraries.lock.json-Datei.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Setzen auf einen beliebigen gültigen Loglevel. Wenn das Flag nicht angegeben ist, ist das Logging deaktiviert.

-d, --dry-run

Optional. Wenn das Flag gesetzt ist, meldet der Befehl auf die übliche Weise, welche Änderungen bei der Ausführung vorgenommen worden wären. Das Dateisystem wird jedoch nicht verändert.

Kommandozeilenbefehl c4-cli library outdated

Überprüft die Repositorys, um festzustellen, ob installierte Bibliotheken (allgemein oder spezifisch) veraltet sind

Verwendung:

c4-cli library outdated [target-path] [library-id] [OPTIONS]
Beispiel 38. Beispiele:
    c4-cli library outdated
    c4-cli library outdated C:/path/to/application.iecapp/
    c4-cli library outdated . "AcmeTools, 1.2.3.4 (Acme Inc)" --all --include-prerelease


Argumente

Beschreibung

[target-path]

Pfad zum Ziel des Befehls. Wenn dies weggelassen wird, verwendet der Befehl standardmäßig das aktuelle Verzeichnis. Gültige Ziele sind ein Applikationsverzeichnis, eine Libraries.json-Datei oder eine Libraries.lock.json-Datei.

[library-id]

Die ID der Bibliothek, für die die Überprüfung auf neuere Versionen ausgeführt werden soll

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Setzen auf einen beliebigen gültigen Loglevel. Wenn das Flag nicht angegeben ist, ist das Logging deaktiviert.

-a, --all

Wenn das Flag gesetzt ist, werden auch veraltete indirekte Referenzen gemeldet.

-p, --include-prerelease

Wenn das Flag gesetzt ist, werden auch Pre-Release-Bibliotheken berücksichtigt.

Kommandozeilenbefehl c4-cli library list

Listet alle Referenzen einer definierten Applikation

Verwendung:

 c4-cli library list [target-path] [OPTIONS]
Beispiel 39. Beispiele:
    c4-cli library list
    c4-cli library list C:/path/to/application.iecapp/
    c4-cli library list --all


Argumente

Beschreibung

[target-path]

Der Pfad zur Datei Libraries.lock.json, für die die Referenzen aufgelistet werden sollen, oder das Applikationsverzeichnis, das eine Datei Libraries.lock.json enthält. Wenn dies weggelassen wird, verwendet der Befehl standardmäßig das aktuelle Verzeichnis.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-a, --all

Wenn das Flag gesetzt ist, werden auch alle indirekten Referenzen aufgelistet.

Kommandozeilenbefehl c4-cli library explain

Gibt die Abhängigkeitskette aus, die dazu führt, dass eine bestimmte Bibliothek referenziert wird

Verwendung:

c4-cli library explain <library> [target-path] [OPTIONS]
Beispiel 40. Beispiele:
    c4-cli library explain "AcmeTools, 1.2.3.4 (Acme Inc)"
    c4-cli library explain "AcmeTools, 1.2.3.4 (Acme Inc)" C:/path/to/Libraries.lock.json
    c4-cli library explain "AcmeTools, 1.2.3.4 (Acme Inc)" C:/path/to/Libraries.lock.json --show-paths


Argumente

Beschreibung

<library>

Die Bibliothek, für die die Abhängigkeitskette ausgegeben werden soll. Dies kann als Bibliotheks-ID oder Namensraum angegeben werden.

[target-path]

Der Pfad zur Datei Libraries.lock.json, in der die jeweilige Bibliothek referenziert wird, oder zu einer Datei Libraries.json im selben Ordner wie die Datei Libraries.lock.json, oder das Applikationsverzeichnis, das eine Datei Libraries.lock.json enthält. Wenn dies weggelassen wird, verwendet der Befehl standardmäßig das aktuelle Verzeichnis.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-p, --show-paths

Wenn das Flag gesetzt ist, werden zusätzlich die Pfade der angezeigten Referenzen angezeigt.

Kommandozeilenbefehl c4-cli library pack

Erstellt ein Archiv der Quellbibliothek aus dem angegebenen CODESYS 4-Bibliotheksprojektordner. Es muss sich um eine gültige Bibliothek handeln.

Verwendung:

    c4-cli library pack [target-path] [zip-path] [OPTIONS]
Beispiel 41. Beispiele:
    c4-cli library pack
    c4-cli library pack C:/path/to/library.fbslib C:/path/to/DestinationDirectory/
    c4-cli library pack C:/path/to/library.fbslib
    c4-cli library pack . C:/path/to/DestinationDirectory/


Argumente

Beschreibung

[target-path]

Optional

Der Pfad zum zu packenden Bibliotheksprojektordner. Wenn dies weggelassen wird, verwendet der Befehl standardmäßig das aktuelle Verzeichnis. Wenn nur [zip-path] gesetzt ist, verwenden Sie hier . als Platzhalter für das aktuelle Verzeichnis.

[zip-path]

Das Verzeichnis, in dem das gepackte Bibliotheksarchiv gespeichert wird. Wenn dies weggelassen wird, wird das Archiv im selben Verzeichnis wie die Bibliothek erstellt.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

Kommandozeilenbefehl c4-cli library save-compiled

Speichert eine bestimmte Bibliothek als kompilierte Bibliothek

Verwendung:

    c4-cli library save-compiled <library-path> <destination-path> [OPTIONS]
Beispiel 42. Beispiele:
    c4-cli library save-compiled C:/path/to/library.fbslib/ C:/path/to/library.compiled-library-v3


Argumente

Beschreibung

<library-path>

Der Pfad zu der Bibliothek, die kompiliert werden soll. Gültige Ziele sind das Bibliotheksprojektverzeichnis, eine Libraries.json-Datei oder eine Libraries.lock.json-Datei. Verwenden Sie . für das aktuelle Verzeichnis.

<destination-path>

Der Pfad, unter dem die kompilierte Bibliothek gespeichert wird. Wenn es sich um ein Verzeichnis handelt, wird die kompilierte Bibliothek in einer Datei mit dem Namen {LibraryName}.compiled-library-v3 in diesem Verzeichnis gespeichert.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-d, --dry-run

Optional. Wenn das Flag gesetzt ist, meldet der Befehl auf die übliche Weise, welche Änderungen bei der Ausführung vorgenommen worden wären. Das Dateisystem wird jedoch nicht verändert.

--overwrite

Die Zieldatei überschreiben, falls sie bereits existiert

--compiler-version

Verwenden einer vorgegebenen Compilerversion

--set-version

Überschreiben der Bibliotheksversion: Wenn dieses Flag gesetzt wird, wird dieser Wert anstelle der SemVer-Version in der Datei ProjectInfo.json der Bibliothek verwendet.

--assert-version

Überprüfen der Version in der Datei ProjectInfo.json und Abbrechen des Vorgangs, wenn sie nicht mit der angegebenen Version übereinstimmt

--compression-level

Die gewünschte Komprimierungsstufe für das ZIP-Archiv

--set-released-flag

Wenn dieses Flag gesetzt ist, wird das „Released“-Flag in der kompilierten Bibliothek durch den angegebenen Wert überschrieben.

Wenn dieses Flag gesetzt ist, wird zudem ein leeres Feld für Vorabversionsbezeichnungen erzwungen. In diesem Fall schlägt die Bibliotheksgenerierung fehl, wenn entweder die Option --set-prerelease-labels mit einer nicht leeren Zeichenkette gesetzt ist oder das Feld SemVer version in der Datei ProjectInfo.json Vorabversionsbezeichnungen angibt, die nicht explizit über die Option --set-prerelease-labels mit einer leeren Zeichenkette überschrieben wurden.

--set-prerelease-labels

Überschreiben der Vorabversionskennzeichnungen: Wenn das Flag angegeben ist, wird dieser Wert anstelle der Semver-Vorabversionskennzeichnungen in der Datei ProjectInfo.json der Bibliothek verwendet. Wenn der Wert -- gesetzt wird, wird eine Bibliothek ohne Vorabversionskennzeichnung erstellt, selbst wenn in der Datei ProjectInfo.json eine solche angegeben ist.

Ein nicht leeres Vorabversions-Label steht im Konflikt mit --set-released-flag; daher kann --set-prerelease-labels nicht mit einem nicht leeren Label verwendet werden, wenn das Flag --set-released-flag gesetzt ist oder das released-Flag in den Projektinformationen gesetzt ist. Dieser Wert schließt das führende - aus, das in der SemVer-Notation die Versions- und Vorabversions-Labels trennt.

--set-buildinfo-labels

Überschreiben des Build-Info-Labels: Wenn das Flag angegeben ist, wird dieser Wert anstelle des SemVer-Versions-Build-Info-Labels in der Datei ProjectInfo.json der Bibliothek verwendet. Wenn der Wert auf -- gesetzt wird, wird eine Bibliothek ohne Build-Info-Label erstellt, selbst wenn in der Datei ProjectInfo.json ein Label angegeben ist. Dieser Wert schließt das führende + aus, das in der SemVer-Notation die Versions- oder Vorabversionsbezeichnungen vom Teil mit den Build-Informationen trennt.

--assert-prerelease-labels

Überprüfen der Vorabversions-Label im Feld semver version der Datei ProjectInfo.json der Bibliothek und Abbrechen des Vorgangs, wenn diese nicht mit den angegebenen Labels übereinstimmen. Kann für Plausibilitätsprüfungen in der Pipeline verwendet werden. Wenn der Wert auf -- gesetzt wird, wird sichergestellt, dass in der Datei ProjectInfo.json keine Vorabversions-Labels angegeben sind.

--assert-buildinfo-labels

Überprüfen der Build-Info-Label des SemVer-Versionsfeldes in der Datei ProjectInfo.json der Bibliothek und Abbrechen des Vorgangs, wenn diese nicht mit den angegebenen Labels übereinstimmen. Kann für Plausibilitätsprüfungen in der Pipeline verwendet werden. Wenn der Wert auf -- gesetzt wird, wird sichergestellt, dass in der Datei ProjectInfo.json keine Build-Info-Labels angegeben sind. Dieser Wert schließt das führende + aus, das in der SemVer-Notation die Versions- oder Vorabversionsbezeichnungen vom Teil mit den Build-Informationen trennt.

--include-libdoc

Pfad zum primär kompilierten Dokumentationsarchiv, das von der libdoc-Toolchain erstellt wurde, üblicherweise entweder doc.lmd oder __lmd__.aux[iliary] genannt. Kompilierungsdateien, die dem Schema __lmd__*.aux[iliary] im selben Ordner entsprechen, werden ebenfalls einbezogen, wobei * dem ISO-Sprach-/Ländercode entspricht.

Kommandozeilenbefehl c4-cli library verify

Überprüfen, ob die Bibliotheksauflösungen in der Libraries.lock.json noch gültig sind und weiterhin mit der Libraries.json übereinstimmen. Prüft, ob alle Bibliotheken im Bibliotheks-Cache zugänglich sind und ob keine doppelten Referenzen, aktualisierten Packages oder verwaisten Einträge vorhanden sind

Verwendung:

c4-cli library verify [target-path] [OPTIONS]
Beispiel 43. Beispiele:
    c4-cli library verify C:/path/to/application.iecapp/


Argumente

Beschreibung

[target-path]

Der Pfad zum Ziel des Befehls. Wenn dies weggelassen wird, verwendet der Befehl standardmäßig das aktuelle Verzeichnis. Gültige Ziele sind ein Applikationsverzeichnis, eine Libraries.json-Datei oder eine Libraries.lock.json-Datei.

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

Kommandozeilenbefehl c4-cli library check

Prüft das Bibliotheksprojekt und meldet alle gefundenen Fehler und Warnungen

Verwendung:

c4-cli library check [library-path] [OPTIONS]

Argumente

Beschreibung

[library-path]

Der Pfad zum Bibliotheksprojekt, das vom Compiler geprüft werden soll. Wenn dies weggelassen wird, verwendet der Befehl standardmäßig das aktuelle Verzeichnis

Optionen

Beschreibung

-h, --help

Anzeige der Hilfe zum Befehl

-v, --verbose

Aktiviert die Protokollierung auf der Konsole auf der Stufe information; Kurzform für --log-level=information

--log-level

Legt die Protokollierungsstufe für die Ausgabe auf der Konsole fest (beispielsweise trace, debug, information, warning, error). Standardmäßig wird nichts auf der Konsole protokolliert (none).

-d, --dry-run

Optional. Wenn das Flag gesetzt ist, meldet der Befehl auf die übliche Weise, welche Änderungen bei der Ausführung vorgenommen worden wären. Das Dateisystem wird jedoch nicht verändert.

--pointer-size

Anzunehmende Pointergröße in Bit, kann 32 oder 64 sein; der Standardwert ist 32

--compiler-defines

Kommagetrennte Liste der zu setzenden Compiler-Defines