Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 9 additions & 2 deletions docs/source/overview/environments.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,23 @@ running the following command:
.. tab-item:: :icon:`fa-brands fa-linux` Linux
:sync: linux

.. note::
Use ``--keyword <search_term>`` (optional) to filter environments by keyword.

.. code:: bash

./isaaclab.sh -p scripts/environments/list_envs.py
./isaaclab.sh -p scripts/environments/list_envs.py --keyword <search_term>

.. tab-item:: :icon:`fa-brands fa-windows` Windows
:sync: windows

.. note::
Use ``--keyword <search_term>`` (optional) to filter environments by keyword.

.. code:: batch

isaaclab.bat -p scripts\environments\list_envs.py
isaaclab.bat -p scripts\environments\list_envs.py --keyword <search_term>


We are actively working on adding more environments to the list. If you have any environments that
you would like to add to Isaac Lab, please feel free to open a pull request!
Expand Down
10 changes: 9 additions & 1 deletion scripts/environments/list_envs.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,16 @@

"""Launch Isaac Sim Simulator first."""

import argparse

from isaaclab.app import AppLauncher

# add argparse arguments
parser = argparse.ArgumentParser(description="List Isaac Lab environments.")
parser.add_argument("--keyword", type=str, default=None, help="Keyword to filter environments.")
# parse the arguments
args_cli = parser.parse_args()

# launch omniverse app
app_launcher = AppLauncher(headless=True)
simulation_app = app_launcher.app
Expand Down Expand Up @@ -44,7 +52,7 @@ def main():
index = 0
# acquire all Isaac environments names
for task_spec in gym.registry.values():
if "Isaac" in task_spec.id:
if "Isaac" in task_spec.id and (args_cli.keyword is None or args_cli.keyword in task_spec.id):
# add details to table
table.add_row([index + 1, task_spec.id, task_spec.entry_point, task_spec.kwargs["env_cfg_entry_point"]])
# increment count
Expand Down