How do I list the functions defined in my shell?

Question

I can type alias to show a list of all the aliases.

But for functions, all I can do is grep my .bash_profile.

That only gets the ones in that file, not those defined in subsidiary files or dynamically.

Is there a more convenient way to find out what functions are currently defined?

@AlastairIrvine Thanks for the duplicate nomination; however, I resolved it the other way around. This question has significantly more views and upvotes, as well as a broader selection of answers; and the accepted answer on your nominated duplicate is decidedly obscure and arguably just wrong. — tripleee, Oct 23 '18 at 04:25

score 369 · Accepted Answer · edited Apr 09 '18 at 19:49

369

declare -F

Function names and definitions may be listed with the -f option to the declare builtin command (see Bash Builtins). The -F option to declare will list the function names only (and optionally the source file and line number).

Bash Reference Manual

edited Apr 09 '18 at 19:49

Nick T

25,754
12
83
121

answered Dec 17 '10 at 14:28

The Archetypal Paul

41,321
20
104
134

4

in GNU bash 4.3.46(1)-release (x86_64-pc-linux-gnu) -F lists names / -f lists whole function – ceph3us Jul 29 '16 at 05:35
5

To get the "optional" source file/line#, it appears you must enable extdebug (`shopt -s extdebug`) AND supply one or more function names to the `declare -F` command. IOW, `declare -F` does **not** supply filenames/line#s even when extdebug is enabled, which is not clear from the documentation, nor is it particularly intuitive, IMO. – Ron Burk May 16 '17 at 08:35
See @user495470's answer below for a better solution. – starbeamrainbowlabs Nov 19 '18 at 11:02
In `zsh` (Mac) this was helpful: `$ declare -f > functions.sh` – Vladimir Vukanac Nov 17 '21 at 12:43
Doesn't work on Mac. Prints `EPOCHREALTIME`. `compgen -A function` from @DavidT and @Lri answers works – callOfCode Jan 11 '23 at 14:13

score 103 · Answer 2 · answered Dec 17 '10 at 15:00

103

Assuming bash shell:

typeset -f

will list the functions.

typeset -F

will list just the function names.

answered Dec 17 '10 at 15:00

Randall Bohn

2,597
2
16
20

11

My bash v4.1.17(9)-release says: `Obsolete. See \`help declare'.` – kevinarpe Dec 11 '14 at 13:47
6

It's still nice to know it's a synonym. – bmacnaughton Aug 20 '15 at 01:57

John Lawrence Aspden · Answer 3 · 2014-10-07T20:32:56.107

80

declare -F

will give you the names of all functions

type function_name

will give you the source for a particular function

edited Oct 07 '14 at 20:32

answered Jan 07 '13 at 11:51

John Lawrence Aspden

17,124
11
67
110

3

Or just use declare -f (lowercase) for the source – Katastic Voyage Sep 25 '17 at 08:47
1

+1 for `type` as this also works for aliases (without you needing to know whether your command is one or the other). – Bob Sammers May 17 '21 at 10:24

score 75 · Answer 4 · answered Feb 02 '15 at 12:45

75

declare -F actually prints declare commands and not only function names:

$ declare -F
declare -f function1
declare -f function2

You can use compgen -A function to print only function names:

$ compgen -A function
function1
function2

answered Feb 02 '15 at 12:45

Lri

26,768
8
84
82

11

`compgen -A function` was just what I was looking for. – Aug 01 '15 at 16:02
5

Nice! I wanted aliases as well in my case ... you can get both aliases and functions with `compgen -a -A function` – Matt Byrne Jan 27 '16 at 21:34
3

+1 and I've used the following to output my personal functions only (on Linux Debian): `compgen -A function | grep "^[a-z]\+" | grep -vE "^dequote|^quote|^in_array"` – Dmytro Dzyubak Jul 24 '16 at 16:00
Apparently not available in MacOS / BSD. – TextGeek Jun 30 '21 at 16:18

score 38 · Answer 5 · answered Feb 21 '14 at 04:58

38

typeset is obsolete, please use:

declare -f

or

declare -f function_name

or

type function_name

answered Feb 21 '14 at 04:58

Robert

381
3
2

score 7 · Answer 6 · edited Mar 08 '15 at 21:07

7

set | grep " ()"

In place of grep you can also use fgrep or hgrep (hgrep is my personal favorite, it's grep but it hi-lites the 'grep-ped' result.

hgrep can be found here: ACME Labs hgrep

edited Mar 08 '15 at 21:07

randomusername

7,927
23
50

answered Mar 08 '15 at 08:07

AtomicKobold

99
1
1

1

This will list functions but also variables that have ` ()` in value – Alois Mahdal Mar 25 '16 at 10:01
2

@AloisMahdal Here's one that works: `set | grep " () $" | cut -d' ' -f1`. But it's overly complicated compared to the other answers. – wjandrea Jul 09 '16 at 01:34
5

`grep` is not a good solution for this, strings that match function definitions will cause false positives. @wjandrea can still be caught by multi line strings, as will any regex. – Matt Apr 07 '18 at 21:56

score 7 · Answer 7 · edited Aug 26 '20 at 21:57

I'm no expert at this, still learning, but after finding this question and its answer because I wanted the same, I wrote the following (based on "The Archetypal Paul's declare" answer) to give me ultimately what I was after: a formatted list of both aliases and functions:

function functionaliaslist() {
    echo
    echo -e "\033[1;4;32m""Functions:""\033[0;34m"
    declare -F | awk {'print $3'}
    echo
    echo -e "\033[1;4;32m""Aliases:""\033[0;34m"
    alias | awk {'print $2'} | awk -F= {'print $1'}
    echo
    echo -e "\033[0m"
}

That was before I saw Lri's answer, and so extrapolating from that, I replace the declare and alias lines with appropriate compgen commands instead, to get:

function functionaliaslist() {
    echo
    echo -e "\033[1;4;32m""Functions:""\033[0;34m"
    compgen -A function
    echo
    echo -e "\033[1;4;32m""Aliases:""\033[0;34m"
    compgen -A alias
    echo
    echo -e "\033[0m"
}

Woks a treat for what I wanted. Sharing in case it helps anyone else.

There are a multitude of other "actions" available to compgen -A [action] (and other options for compgen of course). I found a good write-up here which also includes a link to the man page (because man compgen doesn't work in some cases).

score 1 · Answer 8 · answered Sep 15 '20 at 19:29

Bash shell script specific answer

(because this question was marked as a duplicate of this one)

If you have functions exported in your shell a called script will see them. But luckily, they get marked as such.

Copy-Pasta Demo script

#!/bin/bash
foo(){ :;}; bar(){ :;}; baz(){ :;}; export -f foo bar

export -pf

bash -c $'spam(){ :;}; \
echo "RAW:"; \
declare -pF; \
echo "FILTERED:"; \
declare -pF | awk \'$2 !~ /x/{print$3}\''

Transcript in Bash

/tmp $ foo(){ :;}; bar(){ :;}; baz(){ :;}; export -f foo bar

/tmp $ export -pf
bar ()
{
    :
}
declare -fx bar
foo ()
{
    :
}
declare -fx foo

/tmp $ bash -c $'spam(){ :;}; echo "RAW:"; declare -pF; echo "FILTERED:"; declare -pF | awk \'$2 !~ /x/{print$3}\''
RAW:
declare -fx bar
declare -fx foo
declare -f spam
FILTERED:
spam

How do I list the functions defined in my shell?

8 Answers8

Bash shell script specific answer

Copy-Pasta Demo script

Transcript in Bash

Linked

Related