infobim-doc

Referencia CLI

Consulte la línea de comandos de infobim por componente. Cada comando presenta su sintaxis y los argumentos aceptados.

35 comandos · 9 componentes

infobim <command> [flags/parameters]

Índice de comandos

Componente Descripción Comandos
2d Abre el visor 2D opcional (PySide6) para dibujos DXF/DWG y permite seleccionar puntos para anotaciones y elementos IFC. 2
annotation Crea, actualiza, lista, exporta y elimina anotaciones de estilo W3C de un proyecto InfoBIM, incluso a partir de puntos seleccionados en un dibujo DXF. 8
cli Puntos de entrada principales del ejecutable InfoBIM: inicializa un workspace, ejecuta el servidor local e informa la versión instalada. 4
context Inspecciona valores almacenados en el diccionario de contexto de ejecución. 1
dev Delega comandos de desarrollo, como la generación de documentación, a la CLI independiente del workspace ontobdc-dev. 1
drawing Clasifica y extrae vistas semánticas de dibujos CAD — viewports, títulos, clústeres, referencias y relaciones — incluyendo la conversión de DWG a DXF. 1
ifc Reporta la salud de los modelos IFC de un proyecto y crea elementos IFC en puntos seleccionados en un dibujo DXF o DWG. 3
project Crea, adjunta, actualiza, inspecciona y mantiene proyectos InfoBIM y sus entidades. 14
run Ejecuta una máquina de estados finitos en un proyecto InfoBIM, a partir del YAML de su statechart. 1

2d { #component-2d }

Base 2D command handler. { #component-2d-command-1 }

Sintaxis
infobim 2d --help
Argumento Descripción Alias Valor
--help Print the status of the optional 2D stack and the tree of every 2D command registered in the active executable. -h Sin valor

Install the optional 2D viewer extra (PySide6 / Qt DXF viewer). { #component-2d-command-2 }

Sintaxis
infobim 2d --enable
Argumento Descripción Alias Valor
--enable Install the optional InfoBIM 2D extra, which brings PySide6 and the Qt-backed interactive DXF viewer. Equivalent to manually running ‘python -m pip install –upgrade ‘infobim[2d]’’. — Sin valor

annotation { #component-annotation }

Base annotation component command handler. { #component-annotation-command-1 }

Sintaxis
infobim annotation --help
Argumento Descripción Alias Valor
--help Print the tree of commands registered under the `annotation` logical component of InfoBIM. -h Sin valor

Empty optional fields of an annotation of an InfoBIM project. { #component-annotation-command-2 }

Sintaxis
infobim annotation --global-id <value> --guid <value> --clear <value>
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--guid Global id of the annotation to change. — str
--clear Field to empty: text, author or related. Repeat it for each field. — str

Create an annotation of a given type in an InfoBIM project. { #component-annotation-command-3 }

Sintaxis
infobim annotation --global-id <value> --type <value> --title <value> --related <value> --text <value> --author <value>
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--type Type of the annotation, by its IRI or by a label or identifier in any language, such as note, issue or question. Optional: a note when omitted. — str
--title Title of the annotation. — str
--related File of the container the annotation refers to, other than the one it was made on. Optional; repeat it for each file. — Path
--text Text of the annotation. Optional. — str
--author Author of the annotation. Optional. — str

Remove an annotation of an InfoBIM project. { #component-annotation-command-4 }

Sintaxis
infobim annotation --global-id <value> --guid <value> --delete
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--guid Global id of the annotation to remove. — str
--delete Remove the annotation. — Sin valor

Export the annotations of one type of an InfoBIM project, as an Excel workbook. { #component-annotation-command-5 }

Sintaxis
infobim annotation --global-id <value> --export <value> --type <value> --output <value> --language <value>
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--export Format of the export. The only one is: excel. — str
--type Annotation type whose annotations are exported. — str
--output Where to write the file. — Path
--language Language of the words in the file (en, pt-br, es-es). — str

List the annotations of an InfoBIM project, grouped by the annotation types the ontology declares. { #component-annotation-command-6 }

Sintaxis
infobim annotation --global-id <value> --list
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--list List the annotations of the project, grouped by type. — Sin valor

Create an annotation of a given type at points picked on a DXF drawing of an InfoBIM project. { #component-annotation-command-7 }

Sintaxis
infobim annotation --type <value> --point <value>
Argumento Descripción Alias Valor
--type Type of the annotation, by its IRI or by a label or identifier in any language, such as note, issue or question. — str
--point Drawing on which the annotation points are picked. — Path

Change the data of an annotation of an InfoBIM project, by its global id. { #component-annotation-command-8 }

Sintaxis
infobim annotation --global-id <value> --guid <value> --type <value> --title <value> --text <value> --author <value> --related <value>
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--guid Global id of the annotation to change. — str
--type New type of the annotation. — str
--title New title of the annotation. — str
--text New text of the annotation. — str
--author New author of the annotation. — str
--related File of the container the annotation refers to; repeat it for each file. They replace the related documents. — Path

cli { #component-cli }

Base CLI component command handler. { #component-cli-command-1 }

Sintaxis
infobim --help
Argumento Descripción Alias Valor
--help Print the tree of commands registered under the `cli` logical component of InfoBIM. -h Sin valor

Initialize OntoBDC and InfoBIM in the current directory. { #component-cli-command-2 }

Sintaxis
infobim init

Run the local InfoBIM server. { #component-cli-command-3 }

Sintaxis
infobim serve

Display the version of InfoBIM. { #component-cli-command-4 }

Sintaxis
infobim --version
Argumento Descripción Alias Valor
--version Print the version string reported by the active InfoBIM Python distribution installed in the current environment. -v Sin valor

context { #component-context }

Inspect a value in the context dictionary. { #component-context-command-1 }

Sintaxis
infobim context --term <value> --inspect
Argumento Descripción Alias Valor
--term Term or value to inspect in the context dictionary. — str
--inspect Run the context dictionary inspection pipeline. — Sin valor

dev { #component-dev }

Delegate dev commands to the ontobdc-dev workspace CLI. { #component-dev-command-1 }

Sintaxis
infobim dev

drawing { #component-drawing }

Base drawing component command handler. { #component-drawing-command-1 }

Sintaxis
infobim drawing --help
Argumento Descripción Alias Valor
--help Print the tree of commands registered under the `drawing` logical component of InfoBIM. -h Sin valor

ifc { #component-ifc }

Base IFC component command handler. { #component-ifc-command-1 }

Sintaxis
infobim ifc --help
Argumento Descripción Alias Valor
--help Print the tree of commands registered under the `ifc` logical component of InfoBIM. -h Sin valor

Report the health of the IFC models of an InfoBIM project. { #component-ifc-command-2 }

Sintaxis
infobim ifc --global-id <value> --health --ifc-model-path <value>
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--health Report, model by model, which verifications of the geometric health of an IFC model hold and why the others do not. — Sin valor
--ifc-model-path The one IFC model to report on. When omitted, every IFC model the project declares. — Path

Create IFC elements of the kind a term names at points picked on a DXF or DWG drawing. { #component-ifc-command-3 }

Sintaxis
infobim ifc --global-id <value> --term <value> --point <value> --ifc-model-path <value>
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--term Name of the element kind, in natural language. — str
--point DXF or DWG drawing on which the element points are picked. — Path
--ifc-model-path IFC model of the project to create the elements in. When omitted, the project’s own model, named after its IfcProject GlobalId, created if it does not exist yet. — Path

project { #component-project }

Attach an imported InfoBIM project onto the current storage root. { #component-project-command-1 }

Sintaxis
infobim project --project-path <value> --attach <value>
Argumento Descripción Alias Valor
--project-path Resolve an InfoBIM project path from `–project-path`, `–project`, or the current working directory to the project container underneath it. --project Path
--attach Validate the project container’s metadata, register it in the root storage index and then run the project refresh pipeline so datasets, manifests and RO-Crate agree with what the container actually holds. — bool

Base project component command handler. { #component-project-command-2 }

Sintaxis
infobim project --help
Argumento Descripción Alias Valor
--help Print the tree of commands registered under the `project` logical component of InfoBIM. -h Sin valor

Create a new InfoBIM Project with the given name. { #component-project-command-3 }

Sintaxis
infobim project --create <value>
Argumento Descripción Alias Valor
--create Title of the new InfoBIM project to create. A filesystem slug is derived from this title and used as the container folder name; the pipeline then writes the container metadata, initializes the reserved InfoBIM dataset and registers the project in the storage index. — str

Refresh an existing InfoBIM Project container. { #component-project-command-4 }

Sintaxis
infobim project --global-id <value> --refresh
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--refresh Run the project refresh pipeline on the selected InfoBIM project. Refreshing rebuilds datasets, datapackage and RO-Crate from the files the project container actually holds; it never writes values into metadata fields (use `project –update <source>` instead). — Sin valor

Create a new dataset inside a selected InfoBIM Project. { #component-project-command-5 }

Sintaxis
infobim project --global-id <value> --create-dataset <value>
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--create-dataset Title of the new dataset to create inside the selected project. When –global-id is omitted the project is resolved from the current working directory. — str

Delete an InfoBIM Project from the index. { #component-project-command-6 }

Sintaxis
infobim project --global-id <value> --delete <value>
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--delete Storage identifier of the project to unregister. The project is first checked against the InfoBIM contract so a plain container cannot be removed through this command. — str

List the entities of an InfoBIM Project. { #component-project-command-7 }

Sintaxis
infobim project --global-id <value> --entity
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--entity List every entity the project holds, grouped by the dataset of the container that keeps it. — Sin valor

Remove an entity of an InfoBIM Project. { #component-project-command-8 }

Sintaxis
infobim project --global-id <value> --entity <value> --delete
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--entity Global id of the entity to remove. — str
--delete Remove the entity. — Sin valor

Change the fields of an entity of an InfoBIM Project. { #component-project-command-9 }

Sintaxis
infobim project --global-id <value> --entity <value> --update <value>
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--entity Global id of the entity to change. — str
--update The values to write: a path to a .json or .csv file, a JSON object, or key=value assignments separated by commas. — str

Report the health of a registered InfoBIM Project. { #component-project-command-10 }

Sintaxis
infobim project --global-id <value> --health
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--health Run the InfoBIM Project health check capability on the selected project. Health compares what the project declares in metadata, index, manifests and its IfcProject against the files it actually holds and reports every verification that fails. — Sin valor

Inspect a registered InfoBIM Project. { #component-project-command-11 }

Sintaxis
infobim project --global-id <value> --inspect
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--inspect Print the project’s registered metadata along with a static tree summarizing its reserved InfoBIM dataset, linkset and any additional datasets. — Sin valor

Inspect a registered InfoBIM Project in the interactive Textual tree viewer. { #component-project-command-12 }

Sintaxis
infobim project --global-id <value> --inspect --interactive
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--inspect Open the project’s registered metadata along with a tree summarizing its reserved InfoBIM dataset, linkset and any additional datasets inside the interactive Textual viewer. — Sin valor
--interactive Open the project tree in the interactive Textual viewer with keyboard/mouse collapse and expand, native search, keyboard navigation (e=expand all, c=collapse all, q=quit, ↑/↓=navigate, Enter/Space=toggle a node). -i Sin valor

List every storage container registered as an InfoBIM Project. { #component-project-command-13 }

Sintaxis
infobim project --list
Argumento Descripción Alias Valor
--list Print the list of every storage container currently registered as an InfoBIM Project. Containers that do not match the Project contract are excluded from the result instead of being reported as errors. -l Sin valor

Update a registered InfoBIM Project from a declared source. { #component-project-command-14 }

Sintaxis
infobim project --global-id <value> --update <value>
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--update Source of values to write into the project’s metadata and dataset fields. Accepts a path to a .csv file, a path to a .json file, or inline key=value assignments separated by commas. — str

run { #component-run }

Run a finite state machine on an InfoBIM project, from the YAML of its statechart. { #component-run-command-1 }

Sintaxis
infobim run --global-id <value> --fsm <value>
Argumento Descripción Alias Valor
--global-id Resolve the GlobalId of an IfcProject to the InfoBIM project that carries it, and to the container underneath it. — str
--fsm Path of the statechart YAML of the machine to run, or its path inside an installed package. — Path
This site is open source. Improve this page.