{"id":23116417,"url":"https://github.com/3dcitydb/citydb-tool","last_synced_at":"2025-08-16T21:32:45.244Z","repository":{"id":208058026,"uuid":"720730416","full_name":"3dcitydb/citydb-tool","owner":"3dcitydb","description":"3D City Database 5.0 CLI to import/export city model data and to run database operations","archived":false,"fork":false,"pushed_at":"2024-04-16T05:51:12.000Z","size":6940,"stargazers_count":6,"open_issues_count":1,"forks_count":2,"subscribers_count":11,"default_branch":"main","last_synced_at":"2024-04-16T08:13:02.618Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/3dcitydb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-11-19T12:29:54.000Z","updated_at":"2024-04-23T14:27:53.392Z","dependencies_parsed_at":"2023-11-29T10:45:25.744Z","dependency_job_id":"12089177-35ef-4bd6-82f6-9e86a5244369","html_url":"https://github.com/3dcitydb/citydb-tool","commit_stats":null,"previous_names":["3dcitydb/citydb-tool"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3dcitydb%2Fcitydb-tool","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3dcitydb%2Fcitydb-tool/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3dcitydb%2Fcitydb-tool/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/3dcitydb%2Fcitydb-tool/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/3dcitydb","download_url":"https://codeload.github.com/3dcitydb/citydb-tool/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230061493,"owners_count":18166706,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-17T04:16:09.820Z","updated_at":"2025-08-16T21:32:45.236Z","avatar_url":"https://github.com/3dcitydb.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Gradle build](https://img.shields.io/github/actions/workflow/status/3dcitydb/citydb-tool/build-citydb-tool.yml?logo=Gradle\u0026logoColor=white\u0026style=flat-square) [![Docker edge image build](https://img.shields.io/github/actions/workflow/status/3dcitydb/citydb-tool/docker-build-push-edge.yml?label=edge\u0026logo=docker\u0026style=flat-square)](https://github.com/users/3dcitydb/packages/container/package/citydb-tool)\n\n# citydb-tool\n\n3D City Database 5.0 CLI to import/export city model data and to run database operations.\n\n## License\n\nThe citydb-tool is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).\nSee the `LICENSE` file for more details.\n\n## Latest release\n\nThe latest stable release of citydb-tool is `1.0.0`.\n\nDownload the latest citydb-tool release as ZIP package\n[here](https://github.com/3dcitydb/citydb-tool/releases/latest). Previous releases are available from the\n[releases section](https://github.com/3dcitydb/citydb-tool/releases).\n\n## Contributing\n\n* To file bugs found in the software create a GitHub issue.\n* To contribute code for fixing filed issues create a pull request with the issue id.\n* To propose a new feature create a GitHub issue and open a discussion.\n\n## Using\n\nDownload and unzip the latest release or [build](https://github.com/3dcitydb/citydb-tool#building) the program from\nsource. Afterwards, open a shell environment and run the `citydb` script from the program folder to launch the\nprogram. Another option is to use the citydb-tool [Docker image](https://github.com/3dcitydb/citydb-tool#docker).\n\nTo show the help message and all available commands of the citydb-tool, simply type the following:\n\n    \u003e citydb --help\n\nThis will print the following usage information:\n\n```\nUsage: citydb [OPTIONS] COMMAND\nCommand-line interface for the 3D City Database.\n      [@\u003cfilename\u003e...]       One or more argument files containing options.\n      --config-file=\u003cfile\u003e   Load configuration from this file.\n  -L, --log-level=\u003clevel\u003e    Log level: fatal, error, warn, info, debug, trace\n                               (default: info).\n      --log-file=\u003cfile\u003e      Write log messages to this file.\n      --pid-file=\u003cfile\u003e      Create a file containing the process ID.\n      --plugins=\u003cdir\u003e        Load plugins from this directory.\n      --use-plugins=\u003cplugin[=true|false][,\u003cplugin[=true|false]...]\n                             Enable or disable plugins with a matching fully\n                               qualified class name (default: true).\n  -h, --help                 Show this help message and exit.\n  -V, --version              Print version information and exit.\nCommands:\n  help    Display help information about the specified command.\n  import  Import data in a supported format.\n  export  Export data in a supported format.\n  delete  Delete features from the database.\n  index   Perform index operations.\n```\n\nTo get help about a specific command of the citydb-tool, enter the following and replace `COMMAND` with the name of\nthe command you want to learn more about:\n\n    \u003e citydb help COMMAND\n\n## System requirements\n\n* Java 17 or higher\n\nThe citydb-tool can be run on any platform providing appropriate Java support.\n\n## Docker\n\ncitydb-tool is available as Docker image. You can either build your own image using the provided Dockerfile\nor use a pre-built image from [Dockerhub](https://hub.docker.com/r/3dcitydb/citydb-tool) or\n[GitHub packages](https://github.com/3dcitydb/citydb-tool/pkgs/container/citydb-tool). The pre-built image supports\ncommon architectures (`amd64`, `arm64`) can can be pulled with:\n\n    docker pull 3dcitydb/citydb-tool\n    docker pull ghcr.io/3dcitydb/citydb-tool\n\n### Synopsis\n\nThe Docker image exposes the commands of the `citydb-tool`, as described\nin the [usage section](https://github.com/3dcitydb/citydb-tool#usage).\nThe environment variables listed below can be used to specify a 3DCityDB v5 connection. To exchange data with the\ncontainer, mount a host folder to `/data` inside the container.\n\n    docker run --rm --name citydb-tool [-i -t] \\\n        [-e CITYDB_HOST=the.host.de] \\\n        [-e CITYDB_PORT=5432] \\\n        [-e CITYDB_NAME=theDBName] \\\n        [-e CITYDB_SCHEMA=theCityDBSchemaName] \\\n        [-e CITYDB_USERNAME=theUsername] \\\n        [-e CITYDB_PASSWORD=theSecretPass] \\\n        [-e CITYDB_CONN_PROPS=connProperties] \\\n        [-v /my/data/:/data] \\\n    3dcitydb/citydb-tool[:TAG] COMMAND\n\n## Building\n\nThe citydb-tool uses [Gradle](https://gradle.org/) as build system. To build the program from source, clone the repository to your\nlocal machine and run the following command from the root of the repository.\n\n    \u003e gradlew installDist\n\nThe script automatically downloads all required dependencies for building and running the citydb-tool. So make sure you\nare connected to the internet. The build process runs on all major operating systems and only requires a Java 11 JDK or\nhigher to run.\n\nIf the build was successful, you will find the citydb-tool package under `citydb-cli/build/install`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3dcitydb%2Fcitydb-tool","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F3dcitydb%2Fcitydb-tool","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F3dcitydb%2Fcitydb-tool/lists"}