Skip to content

Commit 8ff4576

Browse files
author
Teddy Reed
committed
Merge pull request #20 from osquery/update_readme_2
Update readme to include plugin example start
2 parents 43f5ba4 + ed6712d commit 8ff4576

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,24 @@ example:
5555
osquery.start_extension(name="my_awesome_extension",
5656
version="1.0.0",)
5757
58+
To test this code start an osquery shell:
59+
60+
.. code-block:: none
61+
62+
osqueryi --nodisable_extensions
63+
osquery> select value from osquery_flags where name = 'extensions_socket';
64+
+-----------------------------------+
65+
| value |
66+
+-----------------------------------+
67+
| /Users/USERNAME/.osquery/shell.em |
68+
+-----------------------------------+
69+
70+
Then start the Python extension:
71+
72+
.. code-block:: none
73+
74+
python ./my_table_plugin.py --socket /Users/USERNAME/.osquery/shell.em
75+
5876
This will register a table called "foobar". As you can see, the table will
5977
return two rows:
6078

0 commit comments

Comments
 (0)