# Ansible-doc for lookup plugins

**URL:** <https://forum.ansible.com/t/ansible-doc-for-lookup-plugins/5754>\
**Category:** Get Help\
**Tags:** collections\
**Created:** [May 11, 2024, 4:37pm UTC](https://forum.ansible.com/t/ansible-doc-for-lookup-plugins/5754 "2024-05-11T16:37:52Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![John\_Ratliff](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/john_ratliff/32/3007_2.png) [@John\_Ratliff](https://forum.ansible.com/u/John_Ratliff)\
**Post date:** [May 11, 2024, 4:37pm UTC](https://forum.ansible.com/t/ansible-doc-for-lookup-plugins/5754/1 "2024-05-11T16:37:52Z")

</div>

I wrote a custom lookup plugin in a collection. When I write a custom module, I can run ansible-doc namespace.collection.module\_name to get the documentation, but this doesn’t work for lookup plugins.

I can do ansible-doc -M FULL\_PATH\_TO\_LOOKUP\_DIRECTORY plugin\_name\_without\_collection\_namespace

But that’s not great.

Is there an alternative syntax I’m overlooking? What is the right way to use ansible-doc to view my collection lookup plugin docs?

Thanks,

---

<div class="post-metadata">

**Author:** ![akira6592](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/akira6592/32/222_2.png) [@akira6592](https://forum.ansible.com/u/akira6592)\
**Post date:** [May 13, 2024, 3:13am UTC](https://forum.ansible.com/t/ansible-doc-for-lookup-plugins/5754/2 "2024-05-13T03:13:50Z")

</div>

@John_Ratliff Hello!

How about below:

```auto
ansible-doc namespace.collection.looku_plugin_name -t lookup

```

---

<div class="post-metadata">

**Author:** ![John\_Ratliff](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/john_ratliff/32/3007_2.png) [@John\_Ratliff](https://forum.ansible.com/u/John_Ratliff)\
**Post date:** [May 13, 2024, 11:25am UTC](https://forum.ansible.com/t/ansible-doc-for-lookup-plugins/5754/3 "2024-05-13T11:25:02Z")

</div>

Thanks. That’s right in the help for ansible-doc --help. Not sure how I overlooked that.

---

<div class="post-metadata">

**Author:** ![akira6592](https://sea1.discourse-cdn.com/ansible/user_avatar/forum.ansible.com/akira6592/32/222_2.png) [@akira6592](https://forum.ansible.com/u/akira6592)\
**Post date:** [May 13, 2024, 11:26am UTC](https://forum.ansible.com/t/ansible-doc-for-lookup-plugins/5754/4 "2024-05-13T11:26:29Z")

</div>

I am glad it was resolved!

---

<div class="post-metadata">

**Author:** ![system](https://us1.discourse-cdn.com/ansible/original/1X/1882d9a01da5d8996a862359b0913cc568a39b84.svg) [@system](https://forum.ansible.com/u/system)\
**Post date:** [June 12, 2024, 11:27am UTC](https://forum.ansible.com/t/ansible-doc-for-lookup-plugins/5754/5 "2024-06-12T11:27:28Z")

</div>

Closed on June 12, 2024, 11:27am UTC

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.