Skip to content

Commit f6da7ca

Browse files
committed
docs: update instructions for diffpy.app agentify
1 parent 7b4b01c commit f6da7ca

2 files changed

Lines changed: 32 additions & 0 deletions

File tree

README.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ User applications to help with tasks using diffpy packages. Currently it
4040
contains
4141

4242
- `runmacro`: A runner for DiffPy macro files.
43+
- `agentify`: A deployer for diffpy.cmi agentic skills.
4344

4445
For more information about the diffpy.apps library, please consult our `online documentation <https://diffpy.github.io/diffpy.apps>`_.
4546

docs/source/getting-started.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ diffpy packages. This page contains the instructions for all applications
1313
available, including:
1414

1515
- :ref:`runmacro`
16+
- :ref:`agentify`
1617

1718
.. _runmacro:
1819

@@ -149,3 +150,33 @@ starting point for the refinement.
149150
constraint. e.g. Here, lattice parameter ``a=b=c``,
150151
and ``Usio_0=Uiso_i, i=1,2,3``, ``a`` and ``Uiso_0`` are used as the
151152
reference variables.
153+
154+
.. _agentify:
155+
Use ``agentify`` to deploy agent skills ``diffpy.cmi``
156+
------------------------------------------------------
157+
158+
The ``agentify`` application allows users to deploy agentic skills in the
159+
local environment. To use this application, run:
160+
161+
.. code-block:: bash
162+
163+
diffpy.app agentify
164+
165+
``claude`` and ``codex`` agent skills are supported, and ``claude`` is used
166+
by default. To specify the agent skill, use the ``--agent`` option:
167+
168+
.. code-block:: bash
169+
170+
diffpy.app agentify --agent codex
171+
172+
To deploy the agentic skill to the system directory, use the ``--system`` flag:
173+
174+
.. code-block:: bash
175+
176+
diffpy.app agentify --system
177+
178+
To update the existing ``diffpy.cmi`` agentic skill, use the ``--update`` flag:
179+
180+
.. code-block:: bash
181+
182+
diffpy.app agentify --update

0 commit comments

Comments
 (0)