Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New docs for conan version #3691

Merged
merged 4 commits into from
Apr 22, 2024
Merged

New docs for conan version #3691

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d707bd8
docs
ErniGH Apr 19, 2024
53f6f38
Update reference/commands/version.rst
ErniGH Apr 22, 2024
67e9840
Update reference/commands/version.rst
ErniGH Apr 22, 2024
173b805
Update reference/commands/version.rst
ErniGH Apr 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 39 additions & 2 deletions reference/commands/version.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,41 @@ conan version
:command: conan version -h


The :command:`conan version` command shows the conan version as well the python version from the system:
The :command:`conan version` command shows information about the system and Python environment,
including Conan version, Python version, system platform, architecture, release, CPU, and more:

* **version**: The Conan version.
* **conan_path**: The path to the Conan script.
* *python*: A sub-dictionary containing information about the Python environment, including:
* **version**: The version of Python being used.
* **sys_version**: The full Python system version.
* **sys_executable**: The path to the Python executable.
* **is_frozen**: An indicator of whether the Python script is being run as a frozen file (e.g., using py2exe or PyInstaller).
* **architecture**: The architecture detected by Python.
* *system*: A sub-dictionary containing information about the operating system, including:
* **version**: The version of the operating system.
* **platform**: The platform of the system.
* **system**: The name of the operating system.
* **release**: The release version of the operating system.
* **cpu**: Information about the system's CPU.

.. code-block:: text

$ conan version
version: 2.0.6
conan_path: /Users/myUser/Documents/GitHub/conan/venv/bin/conan
ErniGH marked this conversation as resolved.
Show resolved Hide resolved
python
version: 3.10.4
sys_version: 3.10.4 (main, May 17 2022, 10:53:07) [Clang 13.1.6 (clang-1316.0.21.2.3)]
sys_executable: /Users/myUser/Documents/GitHub/conan/venv/bin/python
ErniGH marked this conversation as resolved.
Show resolved Hide resolved
is_frozen: False
architecture: arm64
system
version: Darwin Kernel Version 23.4.0: Fri Mar 15 00:12:37 PDT 2024; root:xnu-10063.101.17~1/RELEASE_ARM64_T6031
platform: macOS-14.4.1-arm64-arm-64bit
system: Darwin
release: 23.4.0
cpu: arm


The :command:`conan version --format=json` returns a JSON output format in ``stdout`` (which can be redirected to a file) with the following structure:
Expand All @@ -27,8 +53,19 @@ The :command:`conan version --format=json` returns a JSON output format in ``std
$ conan version --format=json
{
"version": "2.0.6",
"conan_path": "/Users/myUser/Documents/GitHub/conan/venv/bin/conan",
"python": {
"version": "3.10.4",
"sys_version": "3.10.4 (main, May 17 2022, 10:53:07) [Clang 13.1.6 (clang-1316.0.21.2.3)]"
"sys_version": "3.10.4 (main, May 17 2022, 10:53:07) [Clang 13.1.6 (clang-1316.0.21.2.3)]",
"sys_executable": "/Users/myUser/Documents/GitHub/conan/venv/bin/python",
ErniGH marked this conversation as resolved.
Show resolved Hide resolved
"is_frozen": false,
"architecture": "arm64"
},
"system": {
"version": "Darwin Kernel Version 23.4.0: Fri Mar 15 00:12:37 PDT 2024; root:xnu-10063.101.17~1/RELEASE_ARM64_T6031",
"platform": "macOS-14.4.1-arm64-arm-64bit",
"system": "Darwin",
"release": "23.4.0",
"cpu": "arm"
}
}