Skip to main content

Comando CLI: c4-cli library

Edita las referencias de la biblioteca

Uso:

  c4-cli library [OPTIONS] <COMMAND>
ejemplo 24. Ejemplos
    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


Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

Dominio

Descripción

set-managed <namespace> <library>

Agrega una nueva referencia a la biblioteca administrada Libraries.json archivo o reemplaza una referencia existente

set-relative <namespace> <path>

Agrega una nueva referencia a una ruta relativa a la Libraries.json archivo o reemplaza una referencia existente

set-placeholder <namespace> <placeholder>

Agrega una nueva referencia de marcador de posición al Libraries.json archivo o reemplaza una referencia existente

install

Resuelve todas las bibliotecas de la aplicación y restaura las bibliotecas que faltan en la caché de bibliotecas.

install-placeholder <namespace> <placeholder>

Agrega una nueva referencia a un marcador de posición en el Libraries.json Archivo o reemplaza una referencia existente. Luego resuelve todas las bibliotecas de la aplicación y restaura las bibliotecas faltantes en la caché de bibliotecas.

install-managed <namespace> <library>

Agrega una nueva referencia a la biblioteca administrada Libraries.json Archivo o reemplaza una referencia existente. Luego resuelve todas las bibliotecas de la aplicación y restaura las bibliotecas faltantes en la caché de bibliotecas.

install-relative <namespace> <path>

Agrega una nueva referencia a una ruta relativa a la Libraries.json Archivo o reemplaza una referencia existente. Luego resuelve todas las bibliotecas de la aplicación y restaura las bibliotecas faltantes en la caché de bibliotecas.

restore

Restaura todas las bibliotecas faltantes de una aplicación en la caché de bibliotecas.

clean-install

Verifica el Libraries.lock.json archivos, elimina la caché de la biblioteca e instala todas las bibliotecas a las que hace referencia el Libraries.lock.json archivos

library uninstall <namespace> [target-path]

Desinstala la biblioteca asociada a un espacio de nombres específico. Elimina la propia biblioteca y todas las dependencias a las que hace referencia exclusivamente dicha biblioteca.

resolve

Resuelve las referencias de la biblioteca para una aplicación específica y las escribe en la Libraries.lock.json archivo

remove <namespace> [target-path]

Elimina la referencia a la biblioteca identificada por el espacio de nombres de la Libraries.json archivo

prune

Elimina las referencias indirectas no utilizadas a las bibliotecas de la Libraries.lock.json archivo

outdated

Comprueba los repositorios para determinar si alguna de las bibliotecas instaladas (en general o en particular) está actualmente desactualizada.

list

Enumera todas las referencias de una aplicación específica.

explain <library>

Imprime la cadena de dependencias que provocan que se haga referencia a una biblioteca específica.

pack

Crea un archivo de biblioteca de origen a partir de la especificada. CODESYS 4 Carpeta del proyecto de la biblioteca. Debe ser una biblioteca válida.

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

Guarda una biblioteca específica como una biblioteca compilada.

verify

Verifica si las resoluciones de la biblioteca en Libraries.lock.json siguen siendo válidos y siguen coincidiendo con Libraries.json Comprueba que todas las bibliotecas sean accesibles en la caché de bibliotecas y que no existan referencias duplicadas, paquetes actualizados o huérfanos.

check

Comprueba el proyecto de la biblioteca e informa de cualquier error o advertencia detectados.

Comando CLI: c4-cli library set-managed

Agrega una nueva referencia a la biblioteca administrada Libraries.json Archivo o reemplaza una referencia existente.

Uso:

c4-cli library set-managed <namespace> <library> [target-path] [OPTIONS]
ejemplo 25. Ejemplos
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


Argumentos

Descripción

<namespace>

Espacio de nombres de la biblioteca que se va a editar

<library>

ID de la biblioteca o patrón de la biblioteca a agregar

[target-path]

Camino a un Libraries.json Archivo, directorio de la aplicación o directorio de la biblioteca donde se creará o reemplazará la referencia. Si se omite, el comando utilizará por defecto el directorio actual.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-u, --allow-unqualified-access

Si esto está configurado en true, entonces se puede acceder a la biblioteca sin calificación de espacio de nombres. El valor recomendado para el código nuevo es false Esto corresponde a la negación de la qualifiedOnly valor en CODESYS 3, que por defecto es false por razones históricas.

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

Si esto está configurado en true En ese caso, la biblioteca referenciada publicará sus símbolos en la biblioteca contenedora que la referencia. Utilice esta configuración para definir los símbolos publicados al crear una biblioteca contenedora.

-o, --optional

Si esto está configurado en true En ese caso, no se producirán errores de compilación simplemente porque la biblioteca no esté disponible. (Sin embargo, pueden producirse errores de compilación debido a la falta de símbolos en dicha biblioteca).

--no-hash

Se aplica a las referencias de ruta relativas que apuntan a archivos (.zip o .compiled-library). Suprime la generación de valores hash SHA384 en el Libraries.lock.json archivo. Esto es útil en las canalizaciones de compilación y en las canalizaciones de CI de prueba cuando el archivo referenciado se genera anteriormente en la canalización y se espera un cambio en el hash.

-p, --include-prerelease

Si esto está configurado en true, entonces los patrones de versión siempre coincidirán con las versiones de prelanzamiento dentro del rango permitido. De lo contrario, se aplica el comportamiento predeterminado: "Si una versión tiene una etiqueta de prelanzamiento, por ejemplo 1.2.3-alpha.3 – entonces solo se permitirá satisfacer los conjuntos de comparadores si al menos un comparador tiene el mismo [major, minor, patch ] La tupla también tiene una etiqueta de prelanzamiento."

--link-all-content

Solo para casos de uso especiales. Si esto está configurado en true De esta forma, se integrará toda la biblioteca, no solo las partes a las que se hace referencia.

--default-resolution

Opcional (permitido para marcadores de posición). Cuando se activa esta opción, debe ser un ID de biblioteca o un patrón que se utilizará durante la verificación de la biblioteca.

-d, --dry-run

Opcional. Cuando se activa esta opción, no se realizarán cambios en los archivos. En su lugar, se imprimirá en la consola la entrada que se habría escrito.

Comando CLI: c4-cli library set-relative

Agrega una nueva referencia a una ruta relativa a la Libraries.json archivo o reemplaza una referencia existente

Uso:

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


Argumentos

Descripción

<namespace>

Espacio de nombres de la biblioteca que se va a editar

<path>

Ruta al proyecto de biblioteca (empaquetado) o biblioteca compilada que se va a agregar

[target-path]

Camino a un Libraries.json Archivo, directorio de la aplicación o directorio de la biblioteca donde se creará o reemplazará la referencia. Si se omite, el comando utilizará por defecto el directorio actual.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-u, --allow-unqualified-access

Si esto está configurado en true, entonces se puede acceder a la biblioteca sin calificación de espacio de nombres. El valor recomendado para el código nuevo es false Esto corresponde a la negación de la qualifiedOnly valor en CODESYS 3, que por defecto es false por razones históricas.

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

Si esto está configurado en true En ese caso, la biblioteca referenciada publicará sus símbolos en la biblioteca contenedora que la referencia. Utilice esta configuración para definir los símbolos publicados al crear una biblioteca contenedora.

-o, --optional

Si esto está configurado en true En ese caso, no se producirán errores de compilación simplemente porque la biblioteca no esté disponible. (Sin embargo, pueden producirse errores de compilación debido a la falta de símbolos en dicha biblioteca).

--no-hash

Se aplica a las referencias de ruta relativas que apuntan a archivos (.zip o .compiled-library). Suprime la generación de valores hash SHA384 en el Libraries.lock.json archivo. Esto es útil en las canalizaciones de compilación y en las canalizaciones de CI de prueba cuando el archivo referenciado se genera anteriormente en la canalización y se espera un cambio en el hash.

-p, --include-prerelease

Si esto está configurado en true, entonces los patrones de versión siempre coincidirán con las versiones de prelanzamiento dentro del rango permitido. De lo contrario, se aplica el comportamiento predeterminado: "Si una versión tiene una etiqueta de prelanzamiento, por ejemplo 1.2.3-alpha.3 – entonces solo se permitirá satisfacer los conjuntos de comparadores si al menos un comparador tiene el mismo [major, minor, patch ] La tupla también tiene una etiqueta de prelanzamiento."

--link-all-content

Solo para casos de uso especiales. Si esto está configurado en true De esta forma, se integrará toda la biblioteca, no solo las partes a las que se hace referencia.

--default-resolution

Opcional (permitido para marcadores de posición). Cuando se activa esta opción, debe ser un ID de biblioteca o un patrón que se utilizará durante la verificación de la biblioteca.

-d, --dry-run

Opcional. Cuando se activa esta opción, no se realizarán cambios en los archivos. En su lugar, se imprimirá en la consola la entrada que se habría escrito.

Comando CLI: c4-cli library set-placeholder

Agrega una nueva referencia de marcador de posición al Libraries.json archivo o reemplaza una referencia existente

Uso:

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


Argumentos

Descripción

<namespace>

Espacio de nombres de la biblioteca que se va a editar

<placeholder>

Marcador de posición para que la biblioteca agregue

[target-path]

Camino a un Libraries.json Archivo, directorio de la aplicación o directorio de la biblioteca donde se creará o reemplazará la referencia. Si se omite, el comando utilizará por defecto el directorio actual.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-u, --allow-unqualified-access

Si esto está configurado en true, entonces se puede acceder a la biblioteca sin calificación de espacio de nombres. El valor recomendado para el código nuevo es false Esto corresponde a la negación de la qualifiedOnly valor en CODESYS 3, que por defecto es false por razones históricas.

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

Si esto está configurado en true En ese caso, la biblioteca referenciada publicará sus símbolos en la biblioteca contenedora que la referencia. Utilice esta configuración para definir los símbolos publicados al crear una biblioteca contenedora.

-o, --optional

Si esto está configurado en true En ese caso, no se producirán errores de compilación simplemente porque la biblioteca no esté disponible. (Sin embargo, pueden producirse errores de compilación debido a la falta de símbolos en dicha biblioteca).

--no-hash

Se aplica a las referencias de ruta relativas que apuntan a archivos (.zip o .compiled-library). Suprime la generación de valores hash SHA384 en el Libraries.lock.json archivo. Esto es útil en las canalizaciones de compilación y en las canalizaciones de CI de prueba cuando el archivo referenciado se genera anteriormente en la canalización y se espera un cambio en el hash.

-p, --include-prerelease

Si esto está configurado en true, entonces los patrones de versión siempre coincidirán con las versiones de prelanzamiento dentro del rango permitido. De lo contrario, se aplica el comportamiento predeterminado: "Si una versión tiene una etiqueta de prelanzamiento, por ejemplo 1.2.3-alpha.3 – entonces solo se permitirá satisfacer los conjuntos de comparadores si al menos un comparador tiene el mismo [major, minor, patch ] La tupla también tiene una etiqueta de prelanzamiento."

--link-all-content

Solo para casos de uso especiales. Si esto está configurado en true De esta forma, se integrará toda la biblioteca, no solo las partes a las que se hace referencia.

--default-resolution

Opcional (permitido para marcadores de posición). Cuando se activa esta opción, debe ser un ID de biblioteca o un patrón que se utilizará durante la verificación de la biblioteca.

-d, --dry-run

Opcional. Cuando se activa esta opción, no se realizarán cambios en los archivos. En su lugar, se imprimirá en la consola la entrada que se habría escrito.

Comando CLI: c4-cli library install

Resuelve todas las bibliotecas de la aplicación y restaura las bibliotecas que faltan en la caché de bibliotecas.

Uso:

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


Argumentos

Descripción

[target-path]

Ruta al directorio de una aplicación específica, en cuyo contexto se debe ejecutar el comando. Si no se establece la bandera, el comando utilizará por defecto el directorio actual. Los destinos válidos son un directorio de aplicación, un Libraries.json archivo, o un Libraries.lock.json archivo.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-d, --dry-run

Opcional. Cuando se activa esta opción, el comando informará de la forma habitual sobre los cambios realizados durante la ejecución. Sin embargo, el sistema de archivos no se modificará.

Comando CLI: c4-cli library install-placeholder

Agrega una nueva referencia a un marcador de posición en el Libraries.json Archivo o reemplaza una referencia existente. Luego resuelve todas las bibliotecas de la aplicación y restaura las bibliotecas faltantes en la caché de bibliotecas.

Uso:

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


Argumentos

Descripción

<namespace>

Espacio de nombres de una única biblioteca específica para instalar. Si se proporciona este argumento, también debe proporcionar un argumento para library.

<placeholder>

Marcador de posición para que la biblioteca agregue

[target-path]

Ruta al directorio de una aplicación específica, en cuyo contexto se debe ejecutar el comando. Si no se establece la bandera, el comando utilizará por defecto el directorio actual. Los destinos válidos son un directorio de aplicación, un Libraries.json archivo, o un Libraries.lock.json archivo.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-d, --dry-run

Opcional. Cuando se activa esta opción, el comando informará de la forma habitual sobre los cambios realizados durante la ejecución. Sin embargo, el sistema de archivos no se modificará.

Comando CLI: c4-cli library install-managed

Agrega una nueva referencia a la biblioteca administrada Libraries.json Archivo o reemplaza una referencia existente. Luego resuelve todas las bibliotecas de la aplicación y restaura las bibliotecas faltantes en la caché de bibliotecas.

Uso:

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


Argumentos

Descripción

<namespace>

Espacio de nombres de una única biblioteca específica que se va a instalar. El indicador debe especificarse al instalar una única biblioteca específica.

<library>

ID de la biblioteca o patrón de la biblioteca a agregar

[target-path]

Ruta al directorio de una aplicación específica, en cuyo contexto se debe ejecutar el comando. Si no se establece la bandera, el comando utilizará por defecto el directorio actual. Los destinos válidos son un directorio de aplicación, un Libraries.json archivo, o un Libraries.lock.json archivo.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-d, --dry-run

Opcional. Cuando se activa esta opción, el comando informará de la forma habitual sobre los cambios realizados durante la ejecución. Sin embargo, el sistema de archivos no se modificará.

Comando CLI: c4-cli library install-relative

Agrega una nueva referencia a una ruta relativa a la Libraries.json Archivo o reemplaza una referencia existente. Luego resuelve todas las bibliotecas de la aplicación y restaura las bibliotecas faltantes en la caché de bibliotecas.

Uso:

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


Argumentos

Descripción

<namespace>

Espacio de nombres de una única biblioteca específica para instalar. Si se proporciona este argumento, también debe proporcionar un argumento para library.

<path>

Ruta al proyecto de biblioteca (empaquetado) o biblioteca compilada que se va a agregar

[target-path]

Ruta al directorio de una aplicación específica, en cuyo contexto se debe ejecutar el comando. Si no se establece la bandera, el comando utilizará por defecto el directorio actual. Los destinos válidos son un directorio de aplicación, un Libraries.json archivo, o un Libraries.lock.json archivo.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-d, --dry-run

Opcional. Cuando se activa esta opción, el comando informará de la forma habitual sobre los cambios realizados durante la ejecución. Sin embargo, el sistema de archivos no se modificará.

Comando CLI: c4-cli library restore

Restaura todas las bibliotecas faltantes de una aplicación en la caché de bibliotecas.

Uso:

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


Argumentos

Descripción

[target-path]

Ruta al directorio de una aplicación específica, en cuyo contexto se debe ejecutar el comando. Si no se establece la bandera, el comando utilizará por defecto el directorio actual. Los destinos válidos son un directorio de aplicación, un Libraries.json archivo, o un Libraries.lock.json archivo.

[library-id]

Si se proporciona, solo se restaurará la biblioteca especificada (siempre que no exista ya en la caché).

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-d, --dry-run

Opcional. Cuando se activa esta opción, el comando informará de la forma habitual sobre los cambios realizados durante la ejecución. Sin embargo, el sistema de archivos no se modificará.

Comando CLI: c4-cli library clean-install

Verifica el Libraries.lock.json archivos, elimina la caché de la biblioteca e instala todas las bibliotecas a las que hace referencia el Libraries.lock.json archivos

Uso:

c4-cli library clean-install [target-path] [OPTIONS]
ejemplo 33. Ejemplos
    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


Argumentos

Descripción

[target-path]

Ruta al directorio de un proyecto de dispositivo específico, en cuyo contexto se ejecutará el comando. Si no se especifica ningún valor, el comando utilizará por defecto el directorio actual. Los destinos válidos son un directorio de proyecto de dispositivo, un directorio de aplicación, un Libraries.json archivo, o un Libraries.lock.json archivo.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-d, --dry-run

Opcional. Cuando se activa esta opción, el comando informará de la forma habitual sobre los cambios realizados durante la ejecución. Sin embargo, el sistema de archivos no se modificará.

Comando CLI: c4-cli library uninstall

Desinstala la biblioteca asociada a un espacio de nombres específico, eliminando la propia biblioteca y todas las dependencias a las que hace referencia exclusivamente dicha biblioteca.

Uso:

c4-cli library uninstall <namespace> [target-path] [OPTIONS]
ejemplo 34. Ejemplos:
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


Argumentos

Descripción

<namespace>

Espacio de nombres de la biblioteca que se va a desinstalar

[target-path]

Camino a un Libraries.json archivo o un Libraries.lock.json archivo, o a un directorio de la aplicación donde se debe ejecutar el comando de desinstalación. Si se omite, el comando se ejecutará por defecto en el directorio actual.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-d, --dry-run

Opcional. No se realizan cambios en los archivos. Solo se imprimen en la consola los registros de progreso del comando.

Comando CLI: c4-cli library resolve

Resuelve las referencias de la biblioteca para una aplicación específica y las escribe en el archivo. Libraries.lock.json archivo

Uso:

c4-cli library resolve [target-path] [namespace] [OPTIONS]
ejemplo 35. Ejemplos:
    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


Argumentos

Descripción

[target-path]

Ruta al directorio de una aplicación específica, en cuyo contexto se ejecutará el comando. Si no se especifica ningún valor, el comando utilizará por defecto el directorio actual. Los destinos válidos son un directorio de aplicación, un directorio de proyecto de biblioteca, un Libraries.json archivo, o un Libraries.lock.json archivo.

[namespace]

Si se proporciona este argumento, solo se resolverá el espacio de nombres especificado y solo se actualizará la biblioteca resuelta en el archivo de bloqueo.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Se configura con cualquier nivel de registro válido. Si no se especifica el indicador, el registro estará desactivado.

-d, --dry-run

Opcional. Cuando se activa esta opción, el comando informará de la forma habitual sobre los cambios realizados durante la ejecución. Sin embargo, el sistema de archivos no se modificará.

-a, --all

Cuando se establece la bandera, la actual Libraries.lock.json El archivo será descartado y se escribirá uno completamente nuevo.

Comando CLI: c4-cli library remove

Elimina la referencia a la biblioteca identificada por el espacio de nombres de la Libraries.json archivo

Uso:

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


Argumentos

Descripción

<namespace>

Espacio de nombres de la biblioteca que se va a eliminar

[target-path]

Camino a un Libraries.json archivo, directorio de la aplicación o directorio de la biblioteca desde donde se eliminará la referencia. Si se omite, el comando utilizará por defecto el directorio actual.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Se puede configurar a cualquier nivel de registro válido. Si no se especifica el indicador, el registro estará desactivado.

Comando CLI: c4-cli library prune

Elimina las referencias indirectas no utilizadas a las bibliotecas de la Libraries.lock.json archivo

Uso:

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


Argumentos

Descripción

[target-path]

Ruta al destino del comando. Si se omite, el comando utilizará por defecto el directorio actual. Los destinos válidos son un directorio de aplicación, un Libraries.json archivo, o un Libraries.lock.json archivo.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Se configura con cualquier nivel de registro válido. Si no se especifica el indicador, el registro estará desactivado.

-d, --dry-run

Opcional. Cuando se activa esta opción, el comando informará de la forma habitual sobre los cambios realizados durante la ejecución. Sin embargo, el sistema de archivos no se modificará.

Comando CLI: c4-cli library outdated

Comprueba los repositorios para determinar si alguna de las bibliotecas instaladas (en general o en particular) está desactualizada.

Uso:

c4-cli library outdated [target-path] [library-id] [OPTIONS]
ejemplo 38. Ejemplos:
    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


Argumentos

Descripción

[target-path]

Ruta al destino del comando. Si se omite, el comando utilizará por defecto el directorio actual. Los destinos válidos son un directorio de aplicación, un Libraries.json archivo, o un Libraries.lock.json archivo.

[library-id]

ID de la biblioteca para la que se debe ejecutar la comprobación de versiones más recientes.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Se configura con cualquier nivel de registro válido. Si no se especifica el indicador, el registro estará desactivado.

-a, --all

Cuando se activa esta opción, también se informará sobre las referencias indirectas obsoletas.

-p, --include-prerelease

Cuando se activa esta opción, también se tendrán en cuenta las bibliotecas de prelanzamiento.

Comando CLI: c4-cli library list

Enumera todas las referencias de una aplicación definida.

Uso:

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


Argumentos

Descripción

[target-path]

Camino hacia el Libraries.lock.json archivo, para el cual se deben enumerar las referencias, o el directorio de la aplicación que contiene Libraries.lock.json archivo. Si se omite, el comando utilizará por defecto el directorio actual.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-a, --all

Cuando se activa la bandera, también se mostrarán todas las referencias indirectas.

Comando CLI: c4-cli library explain

Imprime la cadena de dependencias que provocan que se haga referencia a una biblioteca específica.

Uso:

c4-cli library explain <library> [target-path] [OPTIONS]
ejemplo 40. Ejemplos:
    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


Argumentos

Descripción

<library>

Biblioteca para la que se debe imprimir la cadena de dependencias. Esto se puede especificar como ID de biblioteca o espacio de nombres.

[target-path]

Camino hacia el Libraries.lock.json archivo donde se hace referencia a la biblioteca correspondiente, o a un Libraries.json archivo junto al Libraries.lock.json archivo, o el directorio de la aplicación que incluye un Libraries.lock.json archivo. Si se omite, el comando utilizará por defecto el directorio actual.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-p, --show-paths

Cuando se activa la bandera, también se mostrarán las rutas de las referencias indicadas.

Comando CLI: c4-cli library pack

Crea un archivo de biblioteca de origen a partir de la especificada. CODESYS 4 Carpeta del proyecto de la biblioteca. Debe ser una biblioteca válida.

Uso:

    c4-cli library pack [target-path] [zip-path] [OPTIONS]
ejemplo 41. Ejemplos:
    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/


Argumentos

Descripción

[target-path]

Opcional

Ruta a la carpeta del proyecto de la biblioteca que se va a empaquetar. Si se omite, el comando utilizará por defecto el directorio actual. Si solo [zip-path] está configurado, entonces usar . Aquí como marcador de posición para el directorio actual.

[zip-path]

Directorio donde se guardará el archivo de la biblioteca empaquetada. Si se omite, el archivo se creará en el mismo directorio que la biblioteca.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

Comando CLI: c4-cli library save-compiled

Guarda una biblioteca específica como una biblioteca compilada.

Uso:

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


Argumentos

Descripción

<library-path>

Ruta a la biblioteca que se va a compilar. Los destinos válidos son el directorio del proyecto de la biblioteca, un Libraries.json archivo, o un Libraries.lock.json archivo. Usar . para el directorio actual.

<destination-path>

Ruta donde se almacenará la biblioteca compilada. Si es un directorio, la biblioteca compilada se guardará en un archivo llamado {LibraryName}.compiled-library-v3 dentro del directorio.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-d, --dry-run

Opcional. Cuando se activa esta opción, el comando informará de la forma habitual sobre los cambios realizados durante la ejecución. Sin embargo, el sistema de archivos no se modificará.

--overwrite

Sobrescribe el archivo de destino si ya existe.

--compiler-version

Utiliza una versión de compilador predefinida

--set-version

Anula la versión de la biblioteca. Si se establece esta bandera, utilice este valor en lugar de la versión semver en la ProjectInfo.json archivo de la biblioteca.

--assert-version

Comprueba la versión en el ProjectInfo.json archivo y aborta el proceso si no coincide con la versión especificada

--compression-level

Nivel de compresión para el archivo ZIP

--set-released-flag

Si se establece esta bandera, la bandera 'Released' se sobrescribirá con el valor especificado en la biblioteca compilada.

Si se establece esta bandera, también se forzará un campo de etiquetas de prelanzamiento vacío. En este caso, la generación de la biblioteca fallará si se produce alguno de los siguientes errores: --set-prerelease-labels La opción se establece con una cadena no vacía, o la SemVer version campo en el ProjectInfo.json El archivo especifica etiquetas de prelanzamiento que no han sido explícitamente sobrescritas con una cadena vacía a través de la --set-prerelease-labels opción.

--set-prerelease-labels

Anula las etiquetas de prelanzamiento. Si se establece esta bandera, se utilizará este valor en lugar de las etiquetas de prelanzamiento semver en el ProjectInfo.json archivo de la biblioteca. Si el valor está configurado en --, entonces se creará una biblioteca sin una etiqueta de prelanzamiento, incluso si se especifica una etiqueta en el ProjectInfo.json archivo.

Una etiqueta de prelanzamiento no vacía entra en conflicto con --set-released-flag; por lo tanto, --set-prerelease-labels no se puede utilizar con una etiqueta no vacía cuando la --set-released-flag La bandera está configurada como verdadera, o la released La bandera se establece en la información del proyecto. Este valor excluye el encabezado - que separa la etiqueta de versión y la etiqueta de prelanzamiento en notación semver.

--set-buildinfo-labels

Anula las etiquetas de información de compilación. Si se establece esta bandera, se utilizará este valor en lugar de la etiqueta de información de compilación de la versión semver en la ProjectInfo.json archivo de la biblioteca. Si el valor está configurado en --, entonces se creará una biblioteca sin una etiqueta de información de compilación, incluso si se especifica una etiqueta en la ProjectInfo.json archivo. Este valor excluye el encabezado + que separa la etiqueta de versión o la etiqueta de prelanzamiento de la parte de información de compilación en notación semver.

--assert-prerelease-labels

Comprueba las etiquetas de prelanzamiento del semver version campo en el ProjectInfo.json archivo de la biblioteca, y aborta el proceso si no coincide con las etiquetas especificadas. Se puede utilizar para comprobaciones de cordura en la canalización. Cuando el valor se establece en --, esto asegurará que el ProjectInfo.json El archivo no especifica ninguna etiqueta de prelanzamiento.

--assert-buildinfo-labels

Comprueba las etiquetas de información de compilación del campo de versión semver en el ProjectInfo.json archivo de la biblioteca, y aborta el proceso si no coincide con las etiquetas especificadas. Se puede utilizar para comprobaciones de cordura en la canalización. Cuando el valor se establece en --, esto asegurará que el ProjectInfo.json El archivo no especifica ninguna etiqueta de información de compilación. Este valor excluye el encabezado + que separa la etiqueta de versión o la etiqueta de prelanzamiento de la parte de información de compilación en notación semver.

--include-libdoc

Ruta al archivo principal de documentación compilada creado por la cadena de herramientas libdoc, generalmente llamado doc.lmd o __lmd__.aux[iliary] Compilar archivos en la misma carpeta que cumplan con la convención de nomenclatura. __lmd__*.aux[iliary] También se incluirá, donde * corresponde al código de idioma/país ISO.

Comando CLI: c4-cli library verify

Verifica si las resoluciones de la biblioteca en Libraries.lock.json siguen siendo válidos y siguen coincidiendo con Libraries.json Comprueba que todas las bibliotecas sean accesibles en la caché de bibliotecas y que no existan referencias duplicadas, paquetes actualizados o huérfanos.

Uso:

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


Argumentos

Descripción

[target-path]

Ruta al destino del comando. Si se omite, el comando utilizará por defecto el directorio actual. Los destinos válidos son un directorio de aplicación, un Libraries.json archivo, o un Libraries.lock.json archivo.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

Comando CLI: c4-cli library check

Comprueba el proyecto de la biblioteca e informa de cualquier error o advertencia detectados.

Uso:

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

Argumentos

Descripción

[library-path]

Ruta al proyecto de biblioteca que se debe verificar. Si se omite, el comando utilizará por defecto el directorio actual.

Opciones

Descripción

-h, --help

Imprime la ayuda para el comando.

-v, --verbose

Permite el registro en la consola en el information nivel; Forma abreviada de --log-level=information

--log-level

Establece el nivel de registro para el registro en la consola, por ejemplo trace, debug, information, warning, o error. Por defecto, no se registra nada en la consola (none).

-d, --dry-run

Opcional. Cuando se activa esta opción, el comando informará de la forma habitual sobre los cambios realizados durante la ejecución. Sin embargo, el sistema de archivos no se modificará.

--pointer-size

Tamaño de puntero asumido (en bits); puede ser 32 o 64 (valor predeterminado 32 )

--compiler-defines

Lista separada por comas de definiciones del compilador para establecer